diff options
author | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-19 18:05:50 +0100 |
---|---|---|
committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-19 18:11:34 +0100 |
commit | 185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch) | |
tree | 2fea02768d6005934547f075586c60ba7aca6253 /arch/x86/include/asm/mp.h | |
parent | 6a685753ce8b6b02b67d64b239143bf19eda63c9 (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 'arch/x86/include/asm/mp.h')
-rw-r--r-- | arch/x86/include/asm/mp.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/arch/x86/include/asm/mp.h b/arch/x86/include/asm/mp.h index e48ba051d9..f4c4d6c257 100644 --- a/arch/x86/include/asm/mp.h +++ b/arch/x86/include/asm/mp.h @@ -124,7 +124,7 @@ typedef void (*mp_run_func)(void *arg); * all, or MP_SELECT_BSP for BSP * @func: Function to run * @arg: Argument to pass to the function - * @return 0 on success, -ve on error + * Return: 0 on success, -ve on error */ int mp_run_on_cpus(int cpu_select, mp_run_func func, void *arg); @@ -133,7 +133,7 @@ int mp_run_on_cpus(int cpu_select, mp_run_func func, void *arg); * * This halts all CPUs except the main one, ready for the OS to use them * - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int mp_park_aps(void); @@ -145,7 +145,7 @@ int mp_park_aps(void); * -EFBIG. * * @cpu_select: Selected CPUs (either a CPU number or MP_SELECT_...) - * @return next CPU number to run on (e.g. 0) + * Return: next CPU number to run on (e.g. 0) */ int mp_first_cpu(int cpu_select); @@ -160,7 +160,7 @@ int mp_first_cpu(int cpu_select); * * @cpu_select: Selected CPUs (either a CPU number or MP_SELECT_...) * @prev_cpu: Previous value returned by mp_first_cpu()/mp_next_cpu() - * @return next CPU number to run on (e.g. 0) + * Return: next CPU number to run on (e.g. 0) */ int mp_next_cpu(int cpu_select, int prev_cpu); #else |