[<prev] [next>] [thread-next>] [day] [month] [year] [list]
Message-ID: <20230703232030.8223-1-rdunlap@infradead.org>
Date: Mon, 3 Jul 2023 16:20:30 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>,
Steven Rostedt <rostedt@...dmis.org>,
Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org
Subject: [PATCH v2 RESEND] Documentation: doc-guide: use '%' constant indicator in Return: examples
Use the 'constant' indicator '%' in the examples for the
Return: values syntax. This can help encourage people to use it.
Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
Suggested-by: Steven Rostedt <rostedt@...dmis.org>
Cc: Jonathan Corbet <corbet@....net>
Cc: linux-doc@...r.kernel.org
Link: https://lore.kernel.org/lkml/20221121154358.36856ca6@gandalf.local.home/
Acked-by: Steven Rostedt (Google) <rostedt@...dmis.org>
---
v2: in Subject, spell 'examples' correctly;
Add Link: and Acked-by: Steven
add Note:
Note: %-ECODE or -%ECODE both work well.
Documentation/doc-guide/kernel-doc.rst | 10 +++++-----
1 file changed, 5 insertions(+), 5 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
@@ -151,9 +151,9 @@ named ``Return``.
line breaks, so if you try to format some text nicely, as in::
* Return:
- * 0 - OK
- * -EINVAL - invalid argument
- * -ENOMEM - out of memory
+ * %0 - OK
+ * %-EINVAL - invalid argument
+ * %-ENOMEM - out of memory
this will all run together and produce::
@@ -163,8 +163,8 @@ named ``Return``.
ReST list, e. g.::
* Return:
- * * 0 - OK to runtime suspend the device
- * * -EBUSY - Device should not be runtime suspended
+ * * %0 - OK to runtime suspend the device
+ * * %-EBUSY - Device should not be runtime suspended
#) If the descriptive text you provide has lines that begin with
some phrase followed by a colon, each of those phrases will be taken
Powered by blists - more mailing lists