kernel-doc: describe the ``literal`` syntax
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Tue, 16 May 2017 11:17:49 +0000 (08:17 -0300)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Tue, 16 May 2017 11:44:24 +0000 (08:44 -0300)
commit5d47c31b59f6c2c7ddce0fcb1be0f85ad39a56fe
tree863a2dff3794b5cac397feba1af5f0254949bd86
parentfd74809e73be1192f2455d39932a94dfa6fb0e83
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>
Documentation/doc-guide/kernel-doc.rst