kernel-api.rst: fix output of the vsnprintf() documentation
authormchehab@s-opensource.com <mchehab@s-opensource.com>
Thu, 30 Mar 2017 20:11:33 +0000 (17:11 -0300)
committerJonathan Corbet <corbet@lwn.net>
Sun, 2 Apr 2017 20:29:19 +0000 (14:29 -0600)
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>
lib/vsprintf.c

index e3bf4e0f10b568ba3d74674642adeff013cb62c8..176641cc549d9ff75dc7cb1a587cc753dd1e7e54 100644 (file)
@@ -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