commit 47b4c025117482649ef7d5068e5070d4e2b5d65a
author Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Wed Jan 19 18:05:50 2022 +0100
committer Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Wed Jan 19 18:11:34 2022 +0100
tree 2fea02768d6005934547f075586c60ba7aca6253
parent 7ff76b46f110448032712b76b0272ac54805987e

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/mips/mach-octeon/include/mach/cvmx-cmd-queue.h

diff --git a/arch/mips/mach-octeon/include/mach/cvmx-cmd-queue.h b/arch/mips/mach-octeon/include/mach/cvmx-cmd-queue.h
index ddc2943..c83d09c 100644
--- a/arch/mips/mach-octeon/include/mach/cvmx-cmd-queue.h
+++ b/arch/mips/mach-octeon/include/mach/cvmx-cmd-queue.h
@@ -154,7 +154,7 @@
  * @param fpa_pool  FPA pool the command queues should come from.
  * @param pool_size Size of each buffer in the FPA pool (bytes)
  *
- * @return CVMX_CMD_QUEUE_SUCCESS or a failure code
+ * Return: CVMX_CMD_QUEUE_SUCCESS or a failure code
  */
 cvmx_cmd_queue_result_t cvmx_cmd_queue_initialize(cvmx_cmd_queue_id_t queue_id, int max_depth,
 						  int fpa_pool, int pool_size);
@@ -166,7 +166,7 @@
  *
  * @param queue_id Queue to shutdown
  *
- * @return CVMX_CMD_QUEUE_SUCCESS or a failure code
+ * Return: CVMX_CMD_QUEUE_SUCCESS or a failure code
  */
 cvmx_cmd_queue_result_t cvmx_cmd_queue_shutdown(cvmx_cmd_queue_id_t queue_id);
 
@@ -176,7 +176,7 @@
  *
  * @param queue_id Hardware command queue to query
  *
- * @return Number of outstanding commands
+ * Return: Number of outstanding commands
  */
 int cvmx_cmd_queue_length(cvmx_cmd_queue_id_t queue_id);
 
@@ -188,7 +188,7 @@
  *
  * @param queue_id Command queue to query
  *
- * @return Command buffer or NULL on failure
+ * Return: Command buffer or NULL on failure
  */
 void *cvmx_cmd_queue_buffer(cvmx_cmd_queue_id_t queue_id);
 
@@ -204,7 +204,7 @@
  *
  * @param queue_id Queue ID to get an index for
  *
- * @return Index into the state arrays
+ * Return: Index into the state arrays
  */
 static inline unsigned int __cvmx_cmd_queue_get_index(cvmx_cmd_queue_id_t queue_id)
 {
@@ -270,7 +270,7 @@
  *
  * @param queue_id Queue id to get
  *
- * @return Queue structure or NULL on failure
+ * Return: Queue structure or NULL on failure
  */
 static inline __cvmx_cmd_queue_state_t *__cvmx_cmd_queue_get_state(cvmx_cmd_queue_id_t queue_id)
 {
@@ -301,7 +301,7 @@
  * @param cmd_count Number of command words to write
  * @param cmds      Array of commands to write
  *
- * @return CVMX_CMD_QUEUE_SUCCESS or a failure code
+ * Return: CVMX_CMD_QUEUE_SUCCESS or a failure code
  */
 static inline cvmx_cmd_queue_result_t
 cvmx_cmd_queue_write(cvmx_cmd_queue_id_t queue_id, bool use_locking, int cmd_count, const u64 *cmds)
@@ -348,7 +348,7 @@
  * @param cmd1     Command
  * @param cmd2     Command
  *
- * @return CVMX_CMD_QUEUE_SUCCESS or a failure code
+ * Return: CVMX_CMD_QUEUE_SUCCESS or a failure code
  */
 static inline cvmx_cmd_queue_result_t cvmx_cmd_queue_write2(cvmx_cmd_queue_id_t queue_id,
 							    bool use_locking, u64 cmd1, u64 cmd2)
@@ -399,7 +399,7 @@
  * @param cmd2     Command
  * @param cmd3     Command
  *
- * @return CVMX_CMD_QUEUE_SUCCESS or a failure code
+ * Return: CVMX_CMD_QUEUE_SUCCESS or a failure code
  */
 static inline cvmx_cmd_queue_result_t
 cvmx_cmd_queue_write3(cvmx_cmd_queue_id_t queue_id, bool use_locking, u64 cmd1, u64 cmd2, u64 cmd3)