summaryrefslogtreecommitdiffstats
path: root/lib/vsprintf.c
diff options
context:
space:
mode:
authormchehab@s-opensource.com <mchehab@s-opensource.com>2017-03-30 17:11:33 -0300
committerJonathan Corbet <corbet@lwn.net>2017-04-02 14:29:19 -0600
commit6cc89134c07b223038be9de7854364bb7ba3a210 (patch)
treea5e53a702c8ab1fbcafe5c2ce820ebac3db047af /lib/vsprintf.c
parentc7e2c0643d7850ff41a0b24d8c11f2a856bb4537 (diff)
downloadlinux-6cc89134c07b223038be9de7854364bb7ba3a210.tar.gz
linux-6cc89134c07b223038be9de7854364bb7ba3a210.tar.bz2
linux-6cc89134c07b223038be9de7854364bb7ba3a210.zip
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>
Diffstat (limited to 'lib/vsprintf.c')
-rw-r--r--lib/vsprintf.c6
1 files changed, 3 insertions, 3 deletions
diff --git a/lib/vsprintf.c b/lib/vsprintf.c
index e3bf4e0f10b5..176641cc549d 100644
--- a/lib/vsprintf.c
+++ b/lib/vsprintf.c
@@ -1954,13 +1954,13 @@ set_precision(struct printf_spec *spec, int prec)
* This function generally follows C99 vsnprintf, but has some
* extensions and a few limitations:
*
- * %n is unsupported
- * %p* is handled by pointer()
+ * - ``%n`` is unsupported
+ * - ``%p*`` is handled by pointer()
*
* See pointer() or Documentation/printk-formats.txt for more
* 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
* be generated for the given input, excluding the trailing