kernel-doc: set verbose mode via environment
PATCH 1/1 kernel-doc: set verbose mode via environment
From: Randy Dunlap <[email protected]>
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.
--- scripts/kernel-doc | 4 ++++ 1 file changed, 4 insertions(+)
scripts/kernel-doc +4 -0
@@ -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
Quoted 14 lines · On Sun, 24 Feb 2008 17:53:58 -0800 Randy Dunlap <[email protected]> wrote:
From: Randy Dunlap <[email protected]>
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 <[email protected]>--- scripts/kernel-doc | 4 ++++ 1 file changed, 4 insertions(+)
scripts/kernel-doc my ($function, %function_table,%paramete · line 256
Quoted 10 lines
scripts/kernel-doc +4
-0@@ -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'?
Quoted 19 lines · On Wed, 27 Feb 2008 19:11:04 -0800 Andrew Morton wrote:
Quoted 17 lines · On Sun, 24 Feb 2008 17:53:58 -0800 Randy Dunlap <[email protected]> wrote:
From: Randy Dunlap <[email protected]>
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 <[email protected]>--- scripts/kernel-doc | 4 ++++ 1 file changed, 4 insertions(+)scripts/kernel-doc +0
-0@@ -247,6 +247,10 @@ my ($function, %function_table,%paramete my ($type,$declaration_name,$return_type); my ($newsection,$newcontents,$prototype,$filelist, $brcount, %source_map);
Quoted 9 lines
scripts/kernel-doc my ($function, %function_table,%paramete · line 256
Quoted 7 lines
scripts/kernel-doc +4
-0+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.htmlShouldn't this be, err, documented somewhere?
I did think about that. I was still wondering where to add it.
Quoted 1 line
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
Quoted 31 lines · Randy Dunlap
Quoted 19 lines · On Wed, 27 Feb 2008 19:11:04 -0800 Andrew Morton wrote:
Quoted 17 lines · On Sun, 24 Feb 2008 17:53:58 -0800 Randy Dunlap <[email protected]> wrote:
From: Randy Dunlap <[email protected]>
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 <[email protected]>--- scripts/kernel-doc | 4 ++++ 1 file changed, 4 insertions(+)scripts/kernel-doc +0
-0@@ -247,6 +247,10 @@ my ($function, %function_table,%paramete my ($type,$declaration_name,$return_type); my ($newsection,$newcontents,$prototype,$filelist, $brcount, %source_map);Quoted 9 lines
scripts/kernel-doc my ($function, %function_table,%paramete · line 256
Quoted 7 lines
scripts/kernel-doc +4
-0+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.htmlShouldn't this be, err, documented somewhere?
Quoted 1 line
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?
Quoted 4 lines
Quoted 2 lines
I'd have expected to obtain this functionality by running `make V=1 foodocs'?
Sam, any thoughts on
Makefilepassing "-v" toscripts/kernel-doc?
Please implemnt this. Either add a flag to docproc or just read the env-variable KBUILD_VERBOSE in kernel-doc.
Sam
PATCH v2 1/1 kernel-doc: set verbose mode via environment
Quoted 5 lines · On Thu, 28 Feb 2008 19:32:34 +0100 Sam Ravnborg wrote:
Quoted 4 lines · Randy Dunlap
Quoted 2 lines · On Wed, 27 Feb 2008 19:11:04 -0800 Andrew Morton wrote:
On Sun, 24 Feb 2008 17:53:58 -0800 Randy Dunlap <[email protected]> wrote:
...
Quoted 6 lines
Quoted 4 lines
Quoted 2 lines
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?
Quoted 5 lines
Quoted 3 lines
Quoted 1 line
I'd have expected to obtain this functionality by running `make V=1 foodocs'?
Sam, any thoughts on
Makefilepassing "-v" toscripts/kernel-doc?Please implemnt this. Either add a flag to docproc or just read the env-variable
KBUILD_VERBOSEin 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 <[email protected]>
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.
--- scripts/kernel-doc | 4 ++++ 1 file changed, 4 insertions(+)
scripts/kernel-doc +4 -0
@@ -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
Quoted 5 lines · Randy Dunlap
Quoted 3 lines
Quoted 1 line
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.
Signature · 3 lines
BOFH excuse #13: we're waiting for [the phone company] to fix that line