From: Borislav Petkov <bbpetkov@yahoo.de>
To: Randy Dunlap <randy.dunlap@oracle.com>
Cc: lkml <linux-kernel@vger.kernel.org>
Subject: [PATCH] [KERNEL-DOC] kill warnings when building mandocs
Date: Fri, 13 Apr 2007 11:14:22 +0200 [thread overview]
Message-ID: <20070413091422.GA15426@zmei.tnic> (raw)
This patch shuts warnings of the sort:
make -C /mnt/samsung_200/sam/kernel/trees/21-rc6/build \
KBUILD_SRC=/mnt/samsung_200/sam/kernel/trees/21-rc6 \
KBUILD_EXTMOD="" -f /mnt/samsung_200/sam/kernel/trees/21-rc6/Makefile mandocs
make -f /mnt/samsung_200/sam/kernel/trees/21-rc6/scripts/Makefile.build obj=scripts/basic
make -f /mnt/samsung_200/sam/kernel/trees/21-rc6/scripts/Makefile.build obj=Documentation/DocBook mandocs
SRCTREE=/mnt/samsung_200/sam/kernel/trees/21-rc6/ /mnt/samsung_200/sam/kernel/trees/21-rc6/build/scripts/basic/docproc doc /mnt/samsung_200/sam/kernel/trees/21-rc6/Documentation/DocBook/wanbook.tmpl >Documentation/DocBook/wanbook.xml
if grep -q refentry Documentation/DocBook/wanbook.xml; then xmlto man -m /mnt/samsung_200/sam/kernel/trees/21-rc6/Documentation/DocBook/stylesheet.xsl -o Documentation/DocBook/man Documentation/DocBook/wanbook.xml ; gzip -f Documentation/DocBook/man/*.9; fi
Note: meta version: No productnumber or alternative sppp_close
Note: meta version: No refmiscinfo@class=version sppp_close
Note: Writing sppp_close.9
Note: meta version: No productnumber or alternative sppp_open
Note: meta version: No refmiscinfo@class=version sppp_open
by adding a RefMiscInfo xml tag in the form of the current kernel version to
the function, struct and enum definitions in files included by kernel-doc when
building 'mandocs'. However, the version string appears truncated on the manpage
due to some constraints in the xml DTD for the man header, I believe, for the
troff output is truncated too.
Signed-off-by: Borislav Petkov <bbpetkov@yahoo.de>
Index: 21-rc6/scripts/kernel-doc
===================================================================
--- 21-rc6.orig/scripts/kernel-doc
+++ 21-rc6/scripts/kernel-doc
@@ -326,6 +326,34 @@ while ($ARGV[0] =~ m/^-(.*)/) {
}
}
+# get kernel version
+sub get_kernel_version() {
+
+ my $version;
+ open (FILE, "../Makefile") || die "Can't open man kernel Makefile: $!";
+
+ EOF: while (my $line = <FILE>)
+ {
+ if ($line =~ /VERSION\s+=\s+(\d+)/) {
+ $version .= $1;
+ next;
+ }
+ if ($line =~ /PATCHLEVEL\s+=\s+(\d+)/) {
+ $version .= ".$1";
+ next;
+ }
+ if ($line =~ /SUBLEVEL\s+=\s+(\d+)/) {
+ $version .= ".$1";
+ next;
+ }
+ if ($line =~ /EXTRAVERSION\s+=\s+(.*)$/) {
+ $version .= $1;
+ last EOF;
+ }
+ }
+ return $version;
+}
+
# generate a sequence of code that will splice in highlighting information
# using the s// operator.
@@ -592,6 +620,7 @@ sub output_function_xml(%) {
print "<refmeta>\n";
print " <refentrytitle><phrase>".$args{'function'}."</phrase></refentrytitle>\n";
print " <manvolnum>9</manvolnum>\n";
+ print " <refmiscinfo class=\"version\">" . get_kernel_version() . "</refmiscinfo>\n";
print "</refmeta>\n";
print "<refnamediv>\n";
print " <refname>".$args{'function'}."</refname>\n";
@@ -668,6 +697,7 @@ sub output_struct_xml(%) {
print "<refmeta>\n";
print " <refentrytitle><phrase>".$args{'type'}." ".$args{'struct'}."</phrase></refentrytitle>\n";
print " <manvolnum>9</manvolnum>\n";
+ print " <refmiscinfo class=\"version\">" . get_kernel_version() . "</refmiscinfo>\n";
print "</refmeta>\n";
print "<refnamediv>\n";
print " <refname>".$args{'type'}." ".$args{'struct'}."</refname>\n";
@@ -752,6 +782,7 @@ sub output_enum_xml(%) {
print "<refmeta>\n";
print " <refentrytitle><phrase>enum ".$args{'enum'}."</phrase></refentrytitle>\n";
print " <manvolnum>9</manvolnum>\n";
+ print " <refmiscinfo class=\"version\">" . get_kernel_version() . "</refmiscinfo>\n";
print "</refmeta>\n";
print "<refnamediv>\n";
print " <refname>enum ".$args{'enum'}."</refname>\n";
next reply other threads:[~2007-04-13 9:14 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-04-13 9:14 Borislav Petkov [this message]
2007-04-13 9:29 ` Borislav Petkov
2007-04-18 17:16 ` Randy Dunlap
2007-04-19 6:30 ` Borislav Petkov
2007-04-19 7:19 ` [PATCHv2] " Borislav Petkov
2007-04-19 16:21 ` Randy Dunlap
2007-04-20 5:59 ` Borislav Petkov
2007-04-21 7:20 ` Andrew Morton
2007-04-22 7:40 ` [PATCHv3] " Borislav Petkov
2007-04-22 7:49 ` [PATCHv3] [KERNEL-DOC] kill warnings when building mandocs (fixed whitespaces) Borislav Petkov
2007-04-22 15:59 ` [PATCHv4] [KERNEL-DOC] kill warnings when building mandocs (final) Borislav Petkov
2007-04-14 16:13 ` [PATCH] [KERNEL-DOC] kill warnings when building mandocs Randy Dunlap
2007-04-15 7:10 ` Borislav Petkov
2007-04-17 10:49 ` Borislav Petkov
2007-04-18 16:03 ` Randy Dunlap
2007-04-19 6:20 ` Borislav Petkov
2007-04-19 15:53 ` Randy Dunlap
2007-04-20 6:02 ` Borislav Petkov
2007-04-25 20:22 ` Randy Dunlap
2007-04-22 23:04 Randy Dunlap
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=20070413091422.GA15426@zmei.tnic \
--to=bbpetkov@yahoo.de \
--cc=linux-kernel@vger.kernel.org \
--cc=randy.dunlap@oracle.com \
/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
all inboxes | Powered by JetHome®