kernel-api.rst: fix output of the vsnprintf() documentation

The vsnprintf() kernel-doc comment uses % character with a special
meaning other than escaping a constant. As ReST already defines
``literal`` as an escape sequence, let's make kernel-doc handle it,
and use it at lib/vsprintf.c.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
mchehab@s-opensource.com 2017-03-30 17:11:33 -03:00 committed by Jonathan Corbet
parent c7e2c0643d
commit 6cc89134c0
1 changed files with 3 additions and 3 deletions

View File

@ -1954,13 +1954,13 @@ set_precision(struct printf_spec *spec, int prec)
* This function generally follows C99 vsnprintf, but has some * This function generally follows C99 vsnprintf, but has some
* extensions and a few limitations: * extensions and a few limitations:
* *
* %n is unsupported * - ``%n`` is unsupported
* %p* is handled by pointer() * - ``%p*`` is handled by pointer()
* *
* See pointer() or Documentation/printk-formats.txt for more * See pointer() or Documentation/printk-formats.txt for more
* extensive description. * extensive description.
* *
* ** Please update the documentation in both places when making changes ** * **Please update the documentation in both places when making changes**
* *
* The return value is the number of characters which would * The return value is the number of characters which would
* be generated for the given input, excluding the trailing * be generated for the given input, excluding the trailing