Messages in this thread Patch in this message | ![/](/images/icornerl.gif) | | From | Randy Dunlap <> | Subject | [PATCH] Documentation: doc-guide: use '%' constant indicator in Return: exmaples | Date | Tue, 22 Nov 2022 10:49:09 -0800 |
| |
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@infradead.org> Suggested-by: Steven Rostedt <rostedt@goodmis.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org --- 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
| ![\](/images/icornerr.gif) |