Skip to contentSkip to conversation

Add kerneldoc documentation for new printk format extensions

PATCH In review Andi Kleen 3 participants 4 messages Oct 7, 2008

Subsystems (2)
Library code Vsprintf
lore
Share & tools
lore

Andi Kleen

author
#0 lore raw

PATCH 1/1 Add kerneldoc documentation for new printk format extensions

Add documentation in kerneldoc for new printk format extensions

This patch documents the new %pS/%pF options in printk in kernel doc.

Hope I didn't miss any other extension.

Signed-off-by Andi Kleen <[email protected]>
kernel/printk.c +2 -0
Index: linux-2.6.27-rc6-misc/kernel/printk.c
===================================================================
@@ -593,6 +593,8 @@ static int have_callable_console(void)
  *
  * See also:
  * printf(3)
+ *
+ * See the vsnprintf() documentation for format string extensions over C99.
  */
 
 asmlinkage int printk(const char *fmt, ...)
lib/vsprintf.c +12 -0
Index: linux-2.6.27-rc6-misc/lib/vsprintf.c
===================================================================
@@ -565,6 +565,10 @@ static char *pointer(const char *fmt, ch
  * @fmt: The format string to use
  * @args: Arguments for the format string
  *
+ * This function follows C99 vsnprintf, but has some extensions:
+ * %pS output the name of a text symbol
+ * %pF output the name of a function pointer
+ *
  * The return value is the number of characters which would
  * be generated for the given input, excluding the trailing
  * '\0', as per ISO C99. If you want to have the exact

@@ -806,6 +810,8 @@ EXPORT_SYMBOL(vsnprintf);
  *
  * Call this function if you are already dealing with a va_list.
  * You probably want scnprintf() instead.
+ *
+ * See the vsnprintf() documentation for format string extensions over C99.
  */
 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
 {

@@ -828,6 +834,8 @@ EXPORT_SYMBOL(vscnprintf);
  * generated for the given input, excluding the trailing null,
  * as per ISO C99.  If the return is greater than or equal to
  * @size, the resulting string is truncated.
+ *
+ * See the vsnprintf() documentation for format string extensions over C99.
  */
 int snprintf(char * buf, size_t size, const char *fmt, ...)
 {

@@ -877,6 +885,8 @@ EXPORT_SYMBOL(scnprintf);
  *
  * Call this function if you are already dealing with a va_list.
  * You probably want sprintf() instead.
+ *
+ * See the vsnprintf() documentation for format string extensions over C99.
  */
 int vsprintf(char *buf, const char *fmt, va_list args)
 {

@@ -894,6 +904,8 @@ EXPORT_SYMBOL(vsprintf);
  * The function returns the number of characters written
  * into @buf. Use snprintf() or scnprintf() in order to avoid
  * buffer overflows.
+ *
+ * See the vsnprintf() documentation for format string extensions over C99.
  */
 int sprintf(char * buf, const char *fmt, ...)
 {
#1 lore raw
Quoted 26 lines · Andi Kleen

Add documentation in kerneldoc for new printk format extensions

This patch documents the new %pS/%pF options in printk in kernel doc.

Hope I didn't miss any other extension.

Signed-off-by Andi Kleen <[email protected]>

Index: linux-2.6.27-rc6-misc/kernel/printk.c
===================================================================

kernel/printk.c +2 -0
@@ -593,6 +593,8 @@ static int have_callable_console(void)
 *
 * See also:
 * printf(3)
+ *
+ * See the vsnprintf() documentation for format string extensions over C99.
 */
 
 asmlinkage int printk(const char *fmt, ...)

Index: linux-2.6.27-rc6-misc/lib/vsprintf.c
===================================================================

lib/vsprintf.c static char *pointer(const char *fmt, ch · line 570

Quoted 6 lines
lib/vsprintf.c +3 -0
@@ -565,6 +565,10 @@ static char *pointer(const char *fmt, ch
 * @fmt: The format string to use
 * @args: Arguments for the format string
 *
+ * This function follows C99 vsnprintf, but has some extensions:
+ * %pS output the name of a text symbol
+ * %pF output the name of a function pointer

s/output/outputs/ ? :)

Signature · 1 line
"Sometimes the only way to stay sane is to go a little crazy."
author
#2 lore raw
Quoted 21 lines · Américo Wang
Quoted 20 lines · Andi Kleen

Add documentation in kerneldoc for new printk format extensions

This patch documents the new %pS/%pF options in printk in kernel doc.

Hope I didn't miss any other extension.

Signed-off-by Andi Kleen <[email protected]>

Index: linux-2.6.27-rc6-misc/kernel/printk.c
===================================================================

kernel/printk.c +2 -0
@@ -593,6 +593,8 @@ static int have_callable_console(void)
 *
 * See also:
 * printf(3)
+ *
+ * See the vsnprintf() documentation for format string extensions over C99.
 */
Quoted 14 lines

lib/vsprintf.c static char *pointer(const char *fmt, ch · line 570

Quoted 12 lines
kernel/printk.c +0 -0
 asmlinkage int printk(const char *fmt, ...)

Index: linux-2.6.27-rc6-misc/lib/vsprintf.c
===================================================================

lib/vsprintf.c +3 -0
@@ -565,6 +565,10 @@ static char *pointer(const char *fmt, ch
 * @fmt: The format string to use
 * @args: Arguments for the format string
 *
+ * This function follows C99 vsnprintf, but has some extensions:
+ * %pS output the name of a text symbol
+ * %pF output the name of a function pointer

s/output/outputs/ ? :)

It's not complete sentences but a list of options, so no.

bla do this
blub do that

-Andi

Signature · 1 line
[email protected]
#3 lore raw
Quoted 37 lines · Andi Kleen
Quoted 21 lines · Américo Wang
Quoted 20 lines · Andi Kleen

Add documentation in kerneldoc for new printk format extensions

This patch documents the new %pS/%pF options in printk in kernel doc.

Hope I didn't miss any other extension.

Signed-off-by Andi Kleen <[email protected]>

Index: linux-2.6.27-rc6-misc/kernel/printk.c
===================================================================

kernel/printk.c +2 -0
@@ -593,6 +593,8 @@ static int have_callable_console(void)
 *
 * See also:
 * printf(3)
+ *
+ * See the vsnprintf() documentation for format string extensions over C99.
 */
Quoted 14 lines

lib/vsprintf.c static char *pointer(const char *fmt, ch · line 570

Quoted 12 lines
kernel/printk.c +0 -0
 asmlinkage int printk(const char *fmt, ...)

Index: linux-2.6.27-rc6-misc/lib/vsprintf.c
===================================================================

lib/vsprintf.c +3 -0
@@ -565,6 +565,10 @@ static char *pointer(const char *fmt, ch
 * @fmt: The format string to use
 * @args: Arguments for the format string
 *
+ * This function follows C99 vsnprintf, but has some extensions:
+ * %pS output the name of a text symbol
+ * %pF output the name of a function pointer

s/output/outputs/ ? :)

Quoted 4 lines

It's not complete sentences but a list of options, so no.

bla do this
blub do that

I would use "outputs" _or_ separate the format string extension from the description, like:

* %pS: output the name of a text symbol

Anyway, thanks for adding them.

Signature · 1 line
~Randy