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>

include/linux/clk-provider.h

diff --git a/include/linux/clk-provider.h b/include/linux/clk-provider.h
index 9d296f2..9a61166 100644
--- a/include/linux/clk-provider.h
+++ b/include/linux/clk-provider.h
@@ -84,7 +84,7 @@
  * @table: array of register values corresponding to the parent index (optional)
  * @flags: hardware-specific flags
  * @index: parent clock index
- * @return the register value
+ * Return: the register value
  */
 unsigned int clk_mux_index_to_val(u32 *table, unsigned int flags, u8 index);
 
@@ -143,7 +143,7 @@
  *
  * @table:  array of register values corresponding to valid dividers
  * @val: value to convert
- * @return the divider
+ * Return: the divider
  */
 unsigned int clk_divider_get_table_div(const struct clk_div_table *table,
 				       unsigned int val);
@@ -156,7 +156,7 @@
  *
  * @table: array of register values corresponding to valid dividers
  * @div: requested divider
- * @return the register value
+ * Return: the register value
  */
 unsigned int clk_divider_get_table_val(const struct clk_div_table *table,
 				       unsigned int div);
@@ -167,7 +167,7 @@
  * @table: array of valid dividers (optional)
  * @div: divider to check
  * @flags: hardware-specific flags
- * @return true if the divider is valid, false otherwise
+ * Return: true if the divider is valid, false otherwise
  */
 bool clk_divider_is_valid_div(const struct clk_div_table *table,
 			      unsigned int div, unsigned long flags);
@@ -177,7 +177,7 @@
  *
  * @table: array of valid dividers
  * @div: divider to check
- * @return true if the divider is found in the @table array, false otherwise
+ * Return: true if the divider is found in the @table array, false otherwise
  */
 bool clk_divider_is_valid_table_div(const struct clk_div_table *table,
 				    unsigned int div);

include/linux/string.h

diff --git a/include/linux/string.h b/include/linux/string.h
index 3169c93..df1c1c5 100644
--- a/include/linux/string.h
+++ b/include/linux/string.h
@@ -62,7 +62,7 @@
  * NULL
  * @s: string to search
  * @c: character to search for
- * @return position of @c in @s, or end of @s if not found
+ * Return: position of @c in @s, or end of @s if not found
  */
 const char *strchrnul(const char *s, int c);
 
@@ -89,7 +89,7 @@
  *
  * @s: string to search
  * @reject: strings which cause the search to halt
- * @return number of characters at the start of @s which are not in @reject
+ * Return: number of characters at the start of @s which are not in @reject
  */
 size_t strcspn(const char *s, const char *reject);
 #endif
@@ -136,7 +136,7 @@
  *
  * @src: data to copy in
  * @len: number of bytes to copy
- * @return allocated buffer with the copied contents, or NULL if not enough
+ * Return: allocated buffer with the copied contents, or NULL if not enough
  *	memory is available
  *
  */

include/linux/zstd.h

diff --git a/include/linux/zstd.h b/include/linux/zstd.h
index 35ba4c9..aed20fc 100644
--- a/include/linux/zstd.h
+++ b/include/linux/zstd.h
@@ -1151,7 +1151,7 @@
  *
  * @in: Input buffer to decompress
  * @out: Output buffer to hold the results (must be large enough)
- * @return size of the decompressed data, or -ve on error
+ * Return: size of the decompressed data, or -ve on error
  */
 int zstd_decompress(struct abuf *in, struct abuf *out);