Skip to content

Commit

Permalink
kernel-doc: describe the literal syntax
Browse files Browse the repository at this point in the history
changeset b97f193 ("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: b97f193 ("scripts/kernel-doc: fix parser for apostrophes")
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
  • Loading branch information
mchehab committed May 16, 2017
1 parent fd74809 commit 5d47c31
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions Documentation/doc-guide/kernel-doc.rst
Expand Up @@ -149,6 +149,16 @@ Domain`_ references.
``%CONST``
Name of a constant. (No cross-referencing, just formatting.)

````literal````
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.

``$ENVVAR``
Name of an environment variable. (No cross-referencing, just formatting.)

Expand Down

0 comments on commit 5d47c31

Please sign in to comment.