From: Randy Dunlap <rdunlap@xenotime.net>
To: linux-kernel@vger.kernel.org
Cc: akpm@linux-foundation.org,
Johannes Berg <johannes@sipsolutions.net>,
sam@ravnborg.org
Subject: [PATCH 4/6] kernel-doc: process functions, not DOC:
Date: Wed, 24 Oct 2007 15:08:48 -0700 [thread overview]
Message-ID: <11932637281563@xenotime.net> (raw)
In-Reply-To: <11932637282902@xenotime.net>
From: Johannes Berg <johannes@sipsolutions.net>
This flag is necessary for the next patch for docproc to output
only the functions and not DOC: sections when a function list
is requested.
Signed-off-by: Johannes Berg <johannes@sipsolutions.net>
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
---
scripts/kernel-doc | 14 ++++++++++++--
1 file changed, 12 insertions(+), 2 deletions(-)
--- linux-2.6.23-git19.orig/scripts/kernel-doc
+++ linux-2.6.23-git19/scripts/kernel-doc
@@ -46,13 +46,16 @@ use strict;
# Note: This only supports 'c'.
# usage:
-# kernel-doc [ -docbook | -html | -text | -man ]
+# kernel-doc [ -docbook | -html | -text | -man ] [ -no-doc-sections ]
# [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile
# or
# [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile
#
# Set output format using one of -docbook -html -text or -man. Default is man.
#
+# -no-doc-sections
+# Do not output DOC: sections
+#
# -function funcname
# If set, then only generate documentation for the given function(s) or
# DOC: section titles. All other functions and DOC: sections are ignored.
@@ -211,7 +214,7 @@ my $blankline_text = "";
sub usage {
- print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man ]\n";
+ print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man ] [ -no-doc-sections ]\n";
print " [ -function funcname [ -function funcname ...] ]\n";
print " [ -nofunction funcname [ -nofunction funcname ...] ]\n";
print " c source file(s) > outputfile\n";
@@ -225,6 +228,7 @@ if ($#ARGV==-1) {
my $verbose = 0;
my $output_mode = "man";
+my $no_doc_sections = 0;
my %highlights = %highlights_man;
my $blankline = $blankline_man;
my $modulename = "Kernel API";
@@ -329,6 +333,8 @@ while ($ARGV[0] =~ m/^-(.*)/) {
usage();
} elsif ($cmd eq '-filelist') {
$filelist = shift @ARGV;
+ } elsif ($cmd eq '-no-doc-sections') {
+ $no_doc_sections = 1;
}
}
@@ -380,6 +386,10 @@ sub dump_doc_section {
my $name = shift;
my $contents = join "\n", @_;
+ if ($no_doc_sections) {
+ return;
+ }
+
if (($function_only==0) ||
( $function_only == 1 && defined($function_table{$name})) ||
( $function_only == 2 && !defined($function_table{$name})))
--
next prev parent reply other threads:[~2007-10-24 22:15 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-10-24 22:08 [PATCH 0/6] kernel-doc: add DOC: sections support Randy Dunlap
2007-10-24 22:08 ` [PATCH 5/6] kernel-doc: use no-doc option Randy Dunlap
2007-10-24 22:08 ` [PATCH 3/6] kernel-doc: single DOC: selection Randy Dunlap
2007-10-24 22:08 ` [PATCH 2/6] kernel-doc: init kernel version Randy Dunlap
2007-10-24 22:08 ` [PATCH 6/6] kernel-doc: new P directive for DOC: sections Randy Dunlap
2007-10-24 22:08 ` [PATCH 1/6] kernel-doc: fix xml output mode Randy Dunlap
2007-10-24 22:08 ` Randy Dunlap [this message]
2007-10-25 17:29 ` [PATCH 0/6] kernel-doc: add DOC: sections support Matt Mackall
2007-10-25 17:36 ` Randy Dunlap
2007-10-25 19:21 ` Matt Mackall
2007-10-26 10:48 ` Johannes Berg
2007-10-26 14:46 ` Matt Mackall
2007-10-26 20:32 ` Johannes Berg
2007-10-26 20:18 ` Sam Ravnborg
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=11932637281563@xenotime.net \
--to=rdunlap@xenotime.net \
--cc=akpm@linux-foundation.org \
--cc=johannes@sipsolutions.net \
--cc=linux-kernel@vger.kernel.org \
--cc=sam@ravnborg.org \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox