[PATCH 1/1] part: correct documentation of part_get_bootable()

Heinrich Schuchardt heinrich.schuchardt at canonical.com
Tue Jan 16 15:00:20 CET 2024


We have to use 'Return:' to render the description of the return value in
the HTML documentation.

Fixes: f55aa4454ac3 ("part: Add a fallback for part_get_bootable()")
Fixes: dcffa4428d03 ("part: Add a function to find the first bootable partition")
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt at canonical.com>
---
 include/part.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/part.h b/include/part.h
index db34bc6bb7d..32ee4048856 100644
--- a/include/part.h
+++ b/include/part.h
@@ -685,8 +685,8 @@ int part_get_type_by_name(const char *name);
 /**
  * part_get_bootable() - Find the first bootable partition
  *
- * @desc: Block-device descriptor
- * @return first bootable partition, or 0 if there is none
+ * @desc:	Block-device descriptor
+ * Return:	first bootable partition, or 0 if there is none
  */
 int part_get_bootable(struct blk_desc *desc);
 
-- 
2.43.0



More information about the U-Boot mailing list