[PATCH] doc-guide: kernel-doc: document Returns: spelling

From: Randy Dunlap
Date: Wed May 22 2024 - 18:47:44 EST


scripts/kernel-doc accepts "Return:" or "Returns:" for describing the
return value of a function or function-like macro, so document this
alternative spelling and use it in an example.

Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Suggested-by: Dmitry Baryshkov <dmitry.baryshkov@xxxxxxxxxx>
Cc: Jonathan Corbet <corbet@xxxxxxx>
Cc: linux-doc@xxxxxxxxxxxxxxx
---
Documentation/doc-guide/kernel-doc.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff -- a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst
--- a/Documentation/doc-guide/kernel-doc.rst
+++ b/Documentation/doc-guide/kernel-doc.rst
@@ -143,7 +143,7 @@ Return values
~~~~~~~~~~~~~

The return value, if any, should be described in a dedicated section
-named ``Return``.
+named ``Return`` (or ``Returns``).

.. note::

@@ -337,7 +337,7 @@ Typedefs with function prototypes can al
* Description of the type.
*
* Context: Locking context.
- * Return: Meaning of the return value.
+ * Returns: Meaning of the return value.
*/
typedef void (*type_name)(struct v4l2_ctrl *arg1, void *arg2);