doc: replace @return by Return:
Sphinx expects Return: and not @return to indicate a return value.
find . -name '*.c' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
find . -name '*.h' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
diff --git a/boot/android_ab.c b/boot/android_ab.c
index 4943f26..2d7b392 100644
--- a/boot/android_ab.c
+++ b/boot/android_ab.c
@@ -22,7 +22,7 @@
*
* @param[in] abc bootloader control block
*
- * @return crc32 sum
+ * Return: crc32 sum
*/
static uint32_t ab_control_compute_crc(struct bootloader_control *abc)
{
@@ -38,7 +38,7 @@
*
* @param[in] abc bootloader control block
*
- * @return 0 on success and a negative on error
+ * Return: 0 on success and a negative on error
*/
static int ab_control_default(struct bootloader_control *abc)
{
@@ -81,7 +81,7 @@
* @param[in] part_info Partition in 'dev_desc' where to read from, normally
* the "misc" partition should be used
* @param[out] pointer to pointer to bootloader_control data
- * @return 0 on success and a negative on error
+ * Return: 0 on success and a negative on error
*/
static int ab_control_create_from_disk(struct blk_desc *dev_desc,
const struct disk_partition *part_info,
@@ -131,7 +131,7 @@
* @param[in] part_info Partition on the 'dev_desc' where to write
* @param[in] abc Pointer to the boot control struct and the extra bytes after
* it up to the nearest block boundary
- * @return 0 on success and a negative on error
+ * Return: 0 on success and a negative on error
*/
static int ab_control_store(struct blk_desc *dev_desc,
const struct disk_partition *part_info,
@@ -160,7 +160,7 @@
*
* @param[in] a The first bootable slot metadata
* @param[in] b The second bootable slot metadata
- * @return Negative if the slot "a" is better, positive of the slot "b" is
+ * Return: Negative if the slot "a" is better, positive of the slot "b" is
* better or 0 if they are equally good.
*/
static int ab_compare_slots(const struct slot_metadata *a,
diff --git a/boot/bootm.c b/boot/bootm.c
index 4482f84..00c00ae 100644
--- a/boot/bootm.c
+++ b/boot/bootm.c
@@ -343,7 +343,7 @@
* @comp_type: Compression type being used (IH_COMP_...)
* @uncomp_size: Number of bytes uncompressed
* @ret: errno error code received from compression library
- * @return Appropriate BOOTM_ERR_ error code
+ * Return: Appropriate BOOTM_ERR_ error code
*/
static int handle_decomp_error(int comp_type, size_t uncomp_size, int ret)
{
@@ -434,7 +434,7 @@
/**
* bootm_disable_interrupts() - Disable interrupts in preparation for load/boot
*
- * @return interrupt flag (0 if interrupts were disabled, non-zero if they were
+ * Return: interrupt flag (0 if interrupts were disabled, non-zero if they were
* enabled)
*/
ulong bootm_disable_interrupts(void)
@@ -481,7 +481,7 @@
*
* @buf: Buffer containing the string to process
* @maxlen: Maximum length of buffer
- * @return 0 if OK, -ENOSPC if @maxlen is too small
+ * Return: 0 if OK, -ENOSPC if @maxlen is too small
*/
static int fixup_silent_linux(char *buf, int maxlen)
{
@@ -551,7 +551,7 @@
*
* @buf: Buffer containing the string to process
* @maxlen: Maximum length of buffer
- * @return 0 if OK, -ENOSPC if @maxlen is too small
+ * Return: 0 if OK, -ENOSPC if @maxlen is too small
*/
static int process_subst(char *buf, int maxlen)
{
@@ -655,7 +655,7 @@
* @param states Mask containing states to run (BOOTM_STATE_...)
* @param images Image header information
* @param boot_progress 1 to show boot progress, 0 to not do this
- * @return 0 if ok, something else on error. Some errors will cause this
+ * Return: 0 if ok, something else on error. Some errors will cause this
* function to perform a reboot! If states contains BOOTM_STATE_OS_GO
* then the intent is to boot an OS, so this function will not return
* unless the image type is standalone.
diff --git a/boot/fdt_region.c b/boot/fdt_region.c
index bac5559..295ea08 100644
--- a/boot/fdt_region.c
+++ b/boot/fdt_region.c
@@ -231,7 +231,7 @@
* function)
* @max_regions: Maximum number of regions in @region list
* @info: Place to put the region state
- * @return number of regions after processing, or -FDT_ERR_NOSPACE if we did
+ * Return: number of regions after processing, or -FDT_ERR_NOSPACE if we did
* not have enough room in the regions table for the regions we wanted to add.
*/
int fdt_add_alias_regions(const void *fdt, struct fdt_region *region, int count,
diff --git a/boot/image-android-dt.c b/boot/image-android-dt.c
index a2d52df..fb01419 100644
--- a/boot/image-android-dt.c
+++ b/boot/image-android-dt.c
@@ -14,7 +14,7 @@
* Check if image header is correct.
*
* @param hdr_addr Start address of DT image
- * @return true if header is correct or false if header is incorrect
+ * Return: true if header is correct or false if header is incorrect
*/
bool android_dt_check_header(ulong hdr_addr)
{
@@ -36,7 +36,7 @@
* @param[out] addr If not NULL, will contain address to specified FDT
* @param[out] size If not NULL, will contain size of specified FDT
*
- * @return true on success or false on error
+ * Return: true on success or false on error
*/
bool android_dt_get_fdt_by_index(ulong hdr_addr, u32 index, ulong *addr,
u32 *size)
diff --git a/boot/image-board.c b/boot/image-board.c
index 251885c..0d2e0fc 100644
--- a/boot/image-board.c
+++ b/boot/image-board.c
@@ -321,7 +321,7 @@
* @arch: expected ramdisk architecture
* @rd_datap: pointer to a ulong variable, will hold ramdisk pointer
* @rd_lenp: pointer to a ulong variable, will hold ramdisk length
- * @return 0 if OK, -ENOPKG if no ramdisk (but an error should not be reported),
+ * Return: 0 if OK, -ENOPKG if no ramdisk (but an error should not be reported),
* other -ve value on other error
*/
static int select_ramdisk(bootm_headers_t *images, const char *select, u8 arch,
diff --git a/boot/image-fdt.c b/boot/image-fdt.c
index 7aad6d5..692a9ad 100644
--- a/boot/image-fdt.c
+++ b/boot/image-fdt.c
@@ -258,7 +258,7 @@
* @select: name of FDT to select, or NULL for any
* @arch: expected FDT architecture
* @fdt_addrp: pointer to a ulong variable, will hold FDT pointer
- * @return 0 if OK, -ENOPKG if no FDT (but an error should not be reported),
+ * Return: 0 if OK, -ENOPKG if no FDT (but an error should not be reported),
* other -ve value on other error
*/
diff --git a/boot/image-fit-sig.c b/boot/image-fit-sig.c
index 63e5423..9b1d38b 100644
--- a/boot/image-fit-sig.c
+++ b/boot/image-fit-sig.c
@@ -236,7 +236,7 @@
* /configurations/conf-1/kernel)
* @err_msgp: In the event of an error, this will be pointed to a
* help error string to display to the user.
- * @return 0 if all verified ok, <0 on error
+ * Return: 0 if all verified ok, <0 on error
*/
static int fit_config_check_sig(const void *fit, int noffset,
int required_keynode, int conf_noffset,
diff --git a/boot/image-fit.c b/boot/image-fit.c
index b629339..f6594e0 100644
--- a/boot/image-fit.c
+++ b/boot/image-fit.c
@@ -1595,7 +1595,7 @@
*
* @fit: FIT to check
* @parent: Parent node to check
- * @return 0 if OK, -EADDRNOTAVAIL is a node has a name containing '@'
+ * Return: 0 if OK, -EADDRNOTAVAIL is a node has a name containing '@'
*/
static int fdt_check_no_at(const void *fit, int parent)
{
@@ -1961,7 +1961,7 @@
/**
* fit_get_image_type_property() - get property name for IH_TYPE_...
*
- * @return the properly name where we expect to find the image in the
+ * Return: the properly name where we expect to find the image in the
* config node
*/
static const char *fit_get_image_type_property(int type)
diff --git a/boot/image.c b/boot/image.c
index c7ab034..07fa2d3 100644
--- a/boot/image.c
+++ b/boot/image.c
@@ -550,7 +550,7 @@
* This will scan the translation table trying to find the entry that matches
* the given id.
*
- * @return long entry name if translation succeeds; error string on failure
+ * Return: long entry name if translation succeeds; error string on failure
*/
const char *genimg_get_cat_name(enum ih_category category, uint id)
{
@@ -570,7 +570,7 @@
* This will scan the translation table trying to find the entry that matches
* the given id.
*
- * @return short entry name if translation succeeds; error string on failure
+ * Return: short entry name if translation succeeds; error string on failure
*/
const char *genimg_get_cat_short_name(enum ih_category category, uint id)
{
@@ -600,7 +600,7 @@
* This will scan the translation table trying to find the entry that matches
* the given id.
*
- * @return true if category has entry id; false if not
+ * Return: true if category has entry id; false if not
*/
bool genimg_cat_has_id(enum ih_category category, uint id)
{
diff --git a/boot/pxe_utils.c b/boot/pxe_utils.c
index fcfee5e..bb231b1 100644
--- a/boot/pxe_utils.c
+++ b/boot/pxe_utils.c
@@ -56,7 +56,7 @@
*
* @outbuf: Buffer to write string to
* @outbuf_len: length of buffer
- * @return 1 if OK, -ENOSPC if buffer is too small, -ENOENT is there is no
+ * Return: 1 if OK, -ENOSPC if buffer is too small, -ENOENT is there is no
* current ethernet device
*/
int format_mac_pxe(char *outbuf, size_t outbuf_len)