From 185f812c419f1b4f0d10d9787d59cf9f11a2a600 Mon Sep 17 00:00:00 2001
From: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Date: Wed, 19 Jan 2022 18:05:50 +0100
Subject: 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>
---
 arch/riscv/include/asm/smp.h | 10 +++++-----
 arch/riscv/include/asm/spl.h |  2 +-
 2 files changed, 6 insertions(+), 6 deletions(-)

(limited to 'arch/riscv')

diff --git a/arch/riscv/include/asm/smp.h b/arch/riscv/include/asm/smp.h
index 2dae0800ce..4284a332e9 100644
--- a/arch/riscv/include/asm/smp.h
+++ b/arch/riscv/include/asm/smp.h
@@ -54,7 +54,7 @@ void handle_ipi(ulong hart);
  * @arg0: First argument of function
  * @arg1: Second argument of function
  * @wait: Wait for harts to acknowledge request
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int smp_call_function(ulong addr, ulong arg0, ulong arg1, int wait);
 
@@ -65,7 +65,7 @@ int smp_call_function(ulong addr, ulong arg0, ulong arg1, int wait);
  * the cpu driver is initialized. No other riscv_*_ipi() calls will be made
  * before this function is called.
  *
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int riscv_init_ipi(void);
 
@@ -75,7 +75,7 @@ int riscv_init_ipi(void);
  * Platform code must provide this function.
  *
  * @hart: Hart ID of receiving hart
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int riscv_send_ipi(int hart);
 
@@ -85,7 +85,7 @@ int riscv_send_ipi(int hart);
  * Platform code must provide this function.
  *
  * @hart: Hart ID of hart to be cleared
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int riscv_clear_ipi(int hart);
 
@@ -97,7 +97,7 @@ int riscv_clear_ipi(int hart);
  * @hart: Hart ID of hart to be checked
  * @pending: Pointer to variable with result of the check,
  *           1 if IPI is pending, 0 otherwise
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int riscv_get_ipi(int hart, int *pending);
 
diff --git a/arch/riscv/include/asm/spl.h b/arch/riscv/include/asm/spl.h
index 1487f2d910..e8a94fcb1f 100644
--- a/arch/riscv/include/asm/spl.h
+++ b/arch/riscv/include/asm/spl.h
@@ -31,7 +31,7 @@ enum {
 /**
  * spl_board_init_f() - initialize board in the SPL phase
  *
- * @return 0 if succeeded, -ve on error
+ * Return: 0 if succeeded, -ve on error
  */
 int spl_board_init_f(void);
 
-- 
cgit v1.2.3