LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
* [PATCH] kernel-doc: set verbose mode via environment
@ 2008-02-25  1:53 Randy Dunlap
  2008-02-28  3:11 ` Andrew Morton
  0 siblings, 1 reply; 6+ messages in thread
From: Randy Dunlap @ 2008-02-25  1:53 UTC (permalink / raw)
  To: lkml; +Cc: akpm

From: Randy Dunlap <randy.dunlap@oracle.com>

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@oracle.com>
---
 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

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] kernel-doc: set verbose mode via environment
  2008-02-25  1:53 [PATCH] kernel-doc: set verbose mode via environment Randy Dunlap
@ 2008-02-28  3:11 ` Andrew Morton
  2008-02-28 16:30   ` Randy Dunlap
  0 siblings, 1 reply; 6+ messages in thread
From: Andrew Morton @ 2008-02-28  3:11 UTC (permalink / raw)
  To: Randy Dunlap; +Cc: lkml, Sam Ravnborg

On Sun, 24 Feb 2008 17:53:58 -0800 Randy Dunlap <randy.dunlap@oracle.com> wrote:

> From: Randy Dunlap <randy.dunlap@oracle.com>
> 
> 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@oracle.com>
> ---
>  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'd have expected to obtain this functionality by running `make V=1 foodocs'?

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] kernel-doc: set verbose mode via environment
  2008-02-28  3:11 ` Andrew Morton
@ 2008-02-28 16:30   ` Randy Dunlap
  2008-02-28 18:32     ` Sam Ravnborg
  0 siblings, 1 reply; 6+ messages in thread
From: Randy Dunlap @ 2008-02-28 16:30 UTC (permalink / raw)
  To: Andrew Morton; +Cc: lkml, Sam Ravnborg

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@oracle.com> wrote:
> 
> > From: Randy Dunlap <randy.dunlap@oracle.com>
> > 
> > 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@oracle.com>
> > ---
> >  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

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] kernel-doc: set verbose mode via environment
  2008-02-28 16:30   ` Randy Dunlap
@ 2008-02-28 18:32     ` Sam Ravnborg
  2008-02-29  0:09       ` [PATCH v2] " Randy Dunlap
  0 siblings, 1 reply; 6+ messages in thread
From: Sam Ravnborg @ 2008-02-28 18:32 UTC (permalink / raw)
  To: Randy Dunlap; +Cc: Andrew Morton, lkml

On Thu, Feb 28, 2008 at 08:30:09AM -0800, Randy Dunlap wrote:
> 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@oracle.com> wrote:
> > 
> > > From: Randy Dunlap <randy.dunlap@oracle.com>
> > > 
> > > 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@oracle.com>
> > > ---
> > >  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.
In the same file where you document all the kconfig stuff - so we can let it be
a 'all build features ' document?

> 
> > 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 ?
Please implemnt this. Either add a flag to docproc or
just read the env-variable KBUILD_VERBOSE in kernel-doc.

	Sam

^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH v2] kernel-doc: set verbose mode via environment
  2008-02-28 18:32     ` Sam Ravnborg
@ 2008-02-29  0:09       ` Randy Dunlap
  2008-03-02 21:15         ` Christian Kujau
  0 siblings, 1 reply; 6+ messages in thread
From: Randy Dunlap @ 2008-02-29  0:09 UTC (permalink / raw)
  To: Sam Ravnborg; +Cc: Andrew Morton, lkml

On Thu, 28 Feb 2008 19:32:34 +0100 Sam Ravnborg wrote:

> On Thu, Feb 28, 2008 at 08:30:09AM -0800, Randy Dunlap wrote:
> > 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@oracle.com> wrote:
> > > 
...
> > > 
> > > Shouldn't this be, err, documented somewhere?
> > 
> > I did think about that.  I was still wondering where to add it.
> In the same file where you document all the kconfig stuff - so we can let it be
> a 'all build features ' document?

Which "same file" is that?


> > > 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 ?
> Please implemnt this. Either add a flag to docproc or
> just read the env-variable KBUILD_VERBOSE in kernel-doc.

Sure, I'll change /KERNEL_DOC_VERBOSE/ to /KBUILD_VERBOSE/ in
scripts/kernel-doc.  docproc doesn't need to be involved,
especially since scripts/kernel-doc is easily usable without docproc.

That also means that I can just use the existing KBUILD_VERBOSE
documentation.  :)

---
From: Randy Dunlap <randy.dunlap@oracle.com>

Honor the environment variable "KBUILD_VERBOSE=1" (as set by
make V=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@oracle.com>
---
 scripts/kernel-doc |    4 ++++
 1 file changed, 4 insertions(+)

--- linux-2625-rc3-kdoc.orig/scripts/kernel-doc
+++ linux-2625-rc3-kdoc/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{'KBUILD_VERBOSE'})) {
+	$verbose = "$ENV{'KBUILD_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


^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH v2] kernel-doc: set verbose mode via environment
  2008-02-29  0:09       ` [PATCH v2] " Randy Dunlap
@ 2008-03-02 21:15         ` Christian Kujau
  0 siblings, 0 replies; 6+ messages in thread
From: Christian Kujau @ 2008-03-02 21:15 UTC (permalink / raw)
  To: lkml

On Thu, 28 Feb 2008, Randy Dunlap wrote:
>>> I did think about that.  I was still wondering where to add it.
>> In the same file where you document all the kconfig stuff - so we can let it be
>> a 'all build features ' document?
>
> Which "same file" is that?

Hm, what about ./README (which already lists a few make targets) or 
./Makefile so it's displayed when doing "make help"?

C.
-- 
BOFH excuse #13:

we're waiting for [the phone company] to fix that line

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2008-03-02 21:16 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2008-02-25  1:53 [PATCH] kernel-doc: set verbose mode via environment Randy Dunlap
2008-02-28  3:11 ` Andrew Morton
2008-02-28 16:30   ` Randy Dunlap
2008-02-28 18:32     ` Sam Ravnborg
2008-02-29  0:09       ` [PATCH v2] " Randy Dunlap
2008-03-02 21:15         ` Christian Kujau

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).