summaryrefslogtreecommitdiff
path: root/include/bootm.h
diff options
context:
space:
mode:
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 18:05:50 +0100
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 18:11:34 +0100
commit185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch)
tree2fea02768d6005934547f075586c60ba7aca6253 /include/bootm.h
parent6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff)
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>
Diffstat (limited to 'include/bootm.h')
-rw-r--r--include/bootm.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/include/bootm.h b/include/bootm.h
index 48fc668cf3..7ed5650fca 100644
--- a/include/bootm.h
+++ b/include/bootm.h
@@ -29,7 +29,7 @@ struct cmd_tbl;
* argc is adjusted accordingly. This avoids confusion as to how
* many arguments are available for the OS.
* @images: Pointers to os/initrd/fdt
- * @return 1 on error. On success the OS boots so this function does
+ * Return: 1 on error. On success the OS boots so this function does
* not return.
*/
typedef int boot_os_fn(int flag, int argc, char *const argv[],
@@ -106,7 +106,7 @@ void board_preboot_os(void);
* @buf: buffer holding commandline string to adjust
* @maxlen: Maximum length of buffer at @buf (including \0)
* @flags: Flags to control what happens (see bootm_cmdline_t)
- * @return 0 if OK, -ENOMEM if out of memory, -ENOSPC if the commandline is too
+ * Return: 0 if OK, -ENOMEM if out of memory, -ENOSPC if the commandline is too
* long
*/
int bootm_process_cmdline(char *buf, int maxlen, int flags);
@@ -120,7 +120,7 @@ int bootm_process_cmdline(char *buf, int maxlen, int flags);
* - performing substitutions in the command line ('bootargs_subst' envvar)
*
* @flags: Flags to control what happens (see bootm_cmdline_t)
- * @return 0 if OK, -ENOMEM if out of memory
+ * Return: 0 if OK, -ENOMEM if out of memory
*/
int bootm_process_cmdline_env(int flags);