]> git.dujemihanovic.xyz Git - u-boot.git/commitdiff
part: correct documentation of part_get_bootable()
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Tue, 16 Jan 2024 14:00:20 +0000 (15:00 +0100)
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Sun, 21 Jan 2024 10:24:24 +0000 (11:24 +0100)
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@canonical.com>
include/part.h

index db34bc6bb7d9788fc35ab9424896a911d0abc640..32ee4048856393782e64fba88fcaa3ce03c956eb 100644 (file)
@@ -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);