LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Randy Dunlap <randy.dunlap@oracle.com>
To: Sam Ravnborg <sam@ravnborg.org>
Cc: Andrew Morton <akpm@linux-foundation.org>,
	lkml <linux-kernel@vger.kernel.org>
Subject: [PATCH v2] kernel-doc: set verbose mode via environment
Date: Thu, 28 Feb 2008 16:09:20 -0800	[thread overview]
Message-ID: <20080228160920.c66c7b88.randy.dunlap@oracle.com> (raw)
In-Reply-To: <20080228183234.GA24684@uranus.ravnborg.org>

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


  reply	other threads:[~2008-02-29  0:10 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-02-25  1:53 [PATCH] " 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       ` Randy Dunlap [this message]
2008-03-02 21:15         ` [PATCH v2] " Christian Kujau

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20080228160920.c66c7b88.randy.dunlap@oracle.com \
    --to=randy.dunlap@oracle.com \
    --cc=akpm@linux-foundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=sam@ravnborg.org \
    --subject='Re: [PATCH v2] kernel-doc: set verbose mode via environment' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

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).