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>
---
 drivers/net/octeontx2/cgx.c        | 2 +-
 drivers/net/octeontx2/cgx.h        | 2 +-
 drivers/net/octeontx2/lmt.h        | 2 +-
 drivers/net/octeontx2/nix.c        | 2 +-
 drivers/net/octeontx2/nix_af.c     | 4 ++--
 drivers/net/octeontx2/rvu.h        | 2 +-
 drivers/net/octeontx2/rvu_common.c | 2 +-
 7 files changed, 8 insertions(+), 8 deletions(-)

(limited to 'drivers/net/octeontx2')

diff --git a/drivers/net/octeontx2/cgx.c b/drivers/net/octeontx2/cgx.c
index 189fe7c631..d139029f4e 100644
--- a/drivers/net/octeontx2/cgx.c
+++ b/drivers/net/octeontx2/cgx.c
@@ -52,7 +52,7 @@ char lmac_speed_to_str[][8] = {
  *
  * @param instance	instance to find
  *
- * @return	pointer to lmac data structure or NULL if not found
+ * Return:	pointer to lmac data structure or NULL if not found
  */
 struct lmac *nix_get_cgx_lmac(int lmac_instance)
 {
diff --git a/drivers/net/octeontx2/cgx.h b/drivers/net/octeontx2/cgx.h
index f287692712..b1f6f067bf 100644
--- a/drivers/net/octeontx2/cgx.h
+++ b/drivers/net/octeontx2/cgx.h
@@ -82,7 +82,7 @@ static inline u64 cgx_read(struct cgx *cgx, u8 lmac, u64 offset)
  *
  * @param instance	instance to find
  *
- * @return	pointer to lmac data structure or NULL if not found
+ * Return:	pointer to lmac data structure or NULL if not found
  */
 struct lmac *nix_get_cgx_lmac(int lmac_instance);
 
diff --git a/drivers/net/octeontx2/lmt.h b/drivers/net/octeontx2/lmt.h
index 84a7eab814..3b30992cb6 100644
--- a/drivers/net/octeontx2/lmt.h
+++ b/drivers/net/octeontx2/lmt.h
@@ -15,7 +15,7 @@
  * @param ptr    address in memory to add incr to
  * @param incr   amount to increment memory location by (signed)
  *
- * @return Value of memory location before increment
+ * Return: Value of memory location before increment
  */
 static inline s64 atomic_fetch_and_add64_nosync(s64 *ptr, s64 incr)
 {
diff --git a/drivers/net/octeontx2/nix.c b/drivers/net/octeontx2/nix.c
index 5954737b5c..a5665a25f2 100644
--- a/drivers/net/octeontx2/nix.c
+++ b/drivers/net/octeontx2/nix.c
@@ -36,7 +36,7 @@
  * @param elem_size Size of each element
  * @param msg       Text string to show when allocation fails
  *
- * @return A valid memory location or NULL on failure
+ * Return: A valid memory location or NULL on failure
  */
 static void *nix_memalloc(int num_elements, size_t elem_size, const char *msg)
 {
diff --git a/drivers/net/octeontx2/nix_af.c b/drivers/net/octeontx2/nix_af.c
index d513917ee7..cd098d6cd6 100644
--- a/drivers/net/octeontx2/nix_af.c
+++ b/drivers/net/octeontx2/nix_af.c
@@ -336,7 +336,7 @@ int npa_af_shutdown(struct npa_af *npa_af)
  *
  * @param nix     Handle to setup
  *
- * @return 0, or negative on failure
+ * Return: 0, or negative on failure
  */
 static int nix_af_setup_sq(struct nix *nix)
 {
@@ -445,7 +445,7 @@ static int nix_af_setup_sq(struct nix *nix)
  * @param cindex Context index
  * @param resp   Result pointer
  *
- * @return	0 for success, -EBUSY on failure
+ * Return:	0 for success, -EBUSY on failure
  */
 static int nix_aq_issue_command(struct nix_af *nix_af,
 				int lf,
diff --git a/drivers/net/octeontx2/rvu.h b/drivers/net/octeontx2/rvu.h
index c0a834b89a..62bc7a644a 100644
--- a/drivers/net/octeontx2/rvu.h
+++ b/drivers/net/octeontx2/rvu.h
@@ -101,7 +101,7 @@ int qmem_alloc(struct qmem *q, u32 qsize, size_t entry_sz);
  * @param	inst_size	Size of each instruction
  * @param	res_size	Size of each result
  *
- * @return	-ENOMEM on error, 0 on success
+ * Return:	-ENOMEM on error, 0 on success
  */
 int rvu_aq_alloc(struct admin_queue *aq, unsigned int qsize,
 		 size_t inst_size, size_t res_size);
diff --git a/drivers/net/octeontx2/rvu_common.c b/drivers/net/octeontx2/rvu_common.c
index 173b28ba4b..4d8173f5ba 100644
--- a/drivers/net/octeontx2/rvu_common.c
+++ b/drivers/net/octeontx2/rvu_common.c
@@ -41,7 +41,7 @@ void qmem_free(struct qmem *q)
  * @param	inst_size	Size of each instruction
  * @param	res_size	Size of each result
  *
- * @return	-ENOMEM on error, 0 on success
+ * Return:	-ENOMEM on error, 0 on success
  */
 int rvu_aq_alloc(struct admin_queue *aq, unsigned int qsize,
 		 size_t inst_size, size_t res_size)
-- 
cgit v1.2.3