diff options
| author |   Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-05-16 08:17:49 -0300 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-05-16 08:44:24 -0300 |
| commit | 5d47c31b59f6c2c7ddce0fcb1be0f85ad39a56fe (patch) | |
| tree | 863a2dff3794b5cac397feba1af5f0254949bd86 /Documentation/doc-guide | |
| parent | docs-rst: get rid of Documentation/sphinx/tmplcvt script (diff) | |
| download | wireguard-linux-5d47c31b59f6c2c7ddce0fcb1be0f85ad39a56fe.tar.xz wireguard-linux-5d47c31b59f6c2c7ddce0fcb1be0f85ad39a56fe.zip | |
kernel-doc: describe the ``literal`` syntax
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@s-opensource.com>
Diffstat (limited to 'Documentation/doc-guide')
| -rw-r--r-- | Documentation/doc-guide/kernel-doc.rst | 10 |
1 files changed, 10 insertions, 0 deletions
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. ``%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.) |