Re: [PATCH] kernel-doc: set verbose mode via environment

From: Randy Dunlap
Date: Thu Feb 28 2008 - 11:31:31 EST


On Wed, 27 Feb 2008 19:11:04 -0800 Andrew Morton wrote:

> On Sun, 24 Feb 2008 17:53:58 -0800 Randy Dunlap <randy.dunlap@xxxxxxxxxx> wrote:
>
> > From: Randy Dunlap <randy.dunlap@xxxxxxxxxx>
> >
> > Allow setting environment variable "KERNEL_DOC_VERBOSE=1" to enable
> > verbose mode in scripts/kernel-doc. Useful for getting more
> > info and warnings from kernel-doc.
> >
> > Signed-off-by: Randy Dunlap <randy.dunlap@xxxxxxxxxx>
> > ---
> > scripts/kernel-doc | 4 ++++
> > 1 file changed, 4 insertions(+)
> >
> > --- linux-2.6.25-rc3.orig/scripts/kernel-doc
> > +++ linux-2.6.25-rc3/scripts/kernel-doc
> > @@ -247,6 +247,10 @@ my ($function, %function_table,%paramete
> > my ($type,$declaration_name,$return_type);
> > my ($newsection,$newcontents,$prototype,$filelist, $brcount, %source_map);
> >
> > +if (defined($ENV{'KERNEL_DOC_VERBOSE'})) {
> > + $verbose = "$ENV{'KERNEL_DOC_VERBOSE'}";
> > +}
> > +
> > # Generated docbook code is inserted in a template at a point where
> > # docbook v3.1 requires a non-zero sequence of RefEntry's; see:
> > # http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
>
> Shouldn't this be, err, documented somewhere?

I did think about that. I was still wondering where to add it.

> I'd have expected to obtain this functionality by running `make V=1 foodocs'?

Sam, any thoughts on Makefile passing "-v" to scripts/kernel-doc ?

---
~Randy
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/