[PATCH v2 53/53] kernel-doc: describe the ``literal`` syntax

Mauro Carvalho Chehab mchehab at s-opensource.com
Tue May 16 11:12:00 PDT 2017

changeset b97f193abf83 ("scripts/kernel-doc: fix parser
for apostrophes") added support for ``literal`` inside
kernel-doc, in order to allow using the "%" symbol inside
a literal block, as this is used at printk() description.

Document it.

Fixes: b97f193abf83 ("scripts/kernel-doc: fix parser for apostrophes")
Signed-off-by: Mauro Carvalho Chehab <mchehab at s-opensource.com>
 Documentation/doc-guide/kernel-doc.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst
index b32e4813ff6f..b24854b5d6be 100644
--- a/Documentation/doc-guide/kernel-doc.rst
+++ b/Documentation/doc-guide/kernel-doc.rst
@@ -149,6 +149,16 @@ Domain`_ references.
   Name of a constant. (No cross-referencing, just formatting.)
+  A literal block that should be handled as-is. The output will use a
+  ``monospaced font``.
+  Useful if you need to use special characters that would otherwise have some
+  meaning either by kernel-doc script of by reStructuredText.
+  This is particularly useful if you need to use things like ``%ph`` inside
+  a function description.
   Name of an environment variable. (No cross-referencing, just formatting.)

More information about the linux-mtd mailing list