summaryrefslogtreecommitdiff
path: root/include/relocate.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/relocate.h
parent6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff)
downloadu-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.gz
u-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.bz2
u-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.zip
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/relocate.h')
-rw-r--r--include/relocate.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/include/relocate.h b/include/relocate.h
index 26682da955..2dbfd901e4 100644
--- a/include/relocate.h
+++ b/include/relocate.h
@@ -16,7 +16,7 @@ DECLARE_GLOBAL_DATA_PTR;
/**
* copy_uboot_to_ram() - Copy U-Boot to its new relocated position
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int copy_uboot_to_ram(void);
@@ -25,7 +25,7 @@ int copy_uboot_to_ram(void);
*
* This clears the memory used by global variables
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int clear_bss(void);
@@ -35,7 +35,7 @@ int clear_bss(void);
* This processes the relocation tables to ensure that the code can run in its
* new location.
*
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int do_elf_reloc_fixups(void);
@@ -46,7 +46,7 @@ int do_elf_reloc_fixups(void);
* which need to manually relocate some things.
*
* @ptr: Pointer to relocate
- * @return new pointer value
+ * Return: new pointer value
*/
static inline void *manual_reloc(void *ptr)
{