lkml.org 
[lkml]   [2008]   [Oct]   [7]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH] Add kerneldoc documentation for new printk format extensions
On Tue, 7 Oct 2008, Andi Kleen wrote:

> On Tue, Oct 07, 2008 at 11:33:05AM +0100, Américo Wang wrote:
> > On Tue, Oct 07, 2008 at 12:15:32PM +0200, Andi Kleen wrote:
> > >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 <ak@linux.intel.com>
> > >
> > >Index: linux-2.6.27-rc6-misc/kernel/printk.c
> > >===================================================================
> > >--- linux-2.6.27-rc6-misc.orig/kernel/printk.c
> > >+++ 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, ...)
> > >Index: linux-2.6.27-rc6-misc/lib/vsprintf.c
> > >===================================================================
> > >--- linux-2.6.27-rc6-misc.orig/lib/vsprintf.c
> > >+++ 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
> >
> > s/output/outputs/ ? :)
>
> 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.
--
~Randy
\
 
 \ /
  Last update: 2008-10-07 18:01    [W:0.039 / U:3.700 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site