diff options
| author | Randy Dunlap <rdunlap@infradead.org> | 2023-07-04 02:20:30 +0300 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2023-07-14 22:16:59 +0300 |
| commit | c15ec3d1a287698830798111ede1b7ae0bfef7f6 (patch) | |
| tree | 4b8a01275cc350cedd70eebcd7bfa38a707c1070 /Documentation/doc-guide/kernel-doc.rst | |
| parent | fcb4a2e4cce75be6ef95e4015419a45a6e85f1b2 (diff) | |
| download | linux-c15ec3d1a287698830798111ede1b7ae0bfef7f6.tar.xz | |
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@infradead.org>
Suggested-by: Steven Rostedt <rostedt@goodmis.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Link: https://lore.kernel.org/lkml/20221121154358.36856ca6@gandalf.local.home/
Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20230703232030.8223-1-rdunlap@infradead.org
Diffstat (limited to 'Documentation/doc-guide/kernel-doc.rst')
| -rw-r--r-- | Documentation/doc-guide/kernel-doc.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index 1dcbd7332476..6ad72ac6861b 100644 --- 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 |