Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit dc02c529 authored by Andi Kleen's avatar Andi Kleen Committed by Jonathan Corbet
Browse files

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: default avatarAndi Kleen <ak@linux.intel.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 7e397561

kernel/printk.c

+2 −0
Original line number Diff line number Diff line
@@ -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
Original line number Diff line number Diff line
@@ -565,6 +565,10 @@ static char *pointer(const char *fmt, char *buf, char *end, void *ptr, int field 
 * @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, ...)

{