All of lore.kernel.org
 help / color / mirror / Atom feed
From: Christoph Hellwig <hch@ns.caldera.de>
To: ak@suse.DE (Andi Kleen),
	linux-kernel@vger.kernel.org, torvalds@transmeta.com
Subject: Re: Networking: RFC1122 and 1123 status for kernel 2.4
Date: Sat, 9 Dec 2000 00:17:52 +0100	[thread overview]
Message-ID: <200012082317.AAA04536@ns.caldera.de> (raw)
In-Reply-To: <200012081934.UAA24478@ns.caldera.de>

In article <200012081934.UAA24478@ns.caldera.de> you wrote:
> That could even be automated when this little patch (against -test11, but
> -test12pre works too) is applied...

Ok, I should actually attach the test11-final patch ;)

 	Christoph

-- 
Whip me.  Beat me.  Make me maintain AIX.


diff -uNr --exclude-from=dontdiff linux-2.4.0-test12-pre7/Documentation/DocBook/Makefile linux/Documentation/DocBook/Makefile
--- linux-2.4.0-test12-pre7/Documentation/DocBook/Makefile	Sun Nov 26 17:23:09 2000
+++ linux/Documentation/DocBook/Makefile	Fri Dec  8 22:59:06 2000
@@ -82,11 +82,6 @@
 	$(TOPDIR)/scripts/docgen $(APISOURCES) \
 		<kernel-api.tmpl >kernel-api.sgml
 
-kernel-api-man: $(APISOURCES)
-	@rm -rf $(TOPDIR)/Documentation/man
-	$(TOPDIR)/scripts/kernel-doc -man $^ | \
-		$(PERL) $(TOPDIR)/scripts/split-man $(TOPDIR)/Documentation/man
-
 parportbook: $(JPG-parportbook)
 parportbook.ps: $(EPS-parportbook)
 parportbook.sgml: parportbook.tmpl $(TOPDIR)/drivers/parport/init.c
diff -uNr --exclude-from=dontdiff linux-2.4.0-test12-pre7/Makefile linux/Makefile
--- linux-2.4.0-test12-pre7/Makefile	Thu Dec  7 18:08:35 2000
+++ linux/Makefile	Fri Dec  8 23:00:13 2000
@@ -82,6 +82,13 @@
 export MODLIB
 
 #
+# MANPATH specifies where to install the manpages created from
+# inline documentation
+#
+
+MANDIR	:= /usr/share/man
+
+#
 # standard CFLAGS
 #
 
@@ -197,7 +204,8 @@
 	submenu*
 # directories removed with 'make clean'
 CLEAN_DIRS = \
-	modules
+	modules \
+	Documentation/man
 
 # files removed with 'make mrproper'
 MRPROPER_FILES = \
@@ -435,6 +443,25 @@
 
 htmldocs: sgmldocs
 	$(MAKE) -C Documentation/DocBook html
+
+mandocs:
+	@rm -rf $(TOPDIR)/Documentation/man
+	chmod 755 $(TOPDIR)/scripts/kernel-doc
+	chmod 755 $(TOPDIR)/scripts/split-man
+	( \
+		find include/asm-$(ARCH) -name '*.h' -print; \
+		find $(SUBDIRS) init -name '*.c' -print; \
+		find include -type d \( -name "asm-*" -o -name config \) \
+			-prune -o -name '*.h' -print \
+	) | xargs $(TOPDIR)/scripts/kernel-doc | \
+		$(TOPDIR)/scripts/split-man \
+		$(TOPDIR)/Documentation/man
+
+install-man: mandocs
+	test -d $(MANDIR)/man9 || mkdir -p $(MANDIR)/man9
+	cp $(TOPDIR)/Documentation/man/*.9 $(MANDIR)/man9
+
+	
 
 sums:
 	find . -type f -print | sort | xargs sum > .SUMS
diff -uNr --exclude-from=dontdiff linux-2.4.0-test12-pre7/scripts/kernel-doc linux/scripts/kernel-doc
--- linux-2.4.0-test12-pre7/scripts/kernel-doc	Thu Dec  7 18:08:41 2000
+++ linux/scripts/kernel-doc	Fri Dec  8 22:59:07 2000
@@ -538,7 +538,7 @@
     my ($parameter, $section);
     my $count;
 
-    print ".TH \"$args{'module'}\" 4 \"$args{'function'}\" \"25 May 1998\" \"API Manual\" LINUX\n";
+    print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"25 May 1998\" LINUX\n";
 
     print ".SH NAME\n";
     print $args{'function'}." \\- ".$args{'purpose'}."\n";
@@ -564,13 +564,13 @@
 	$parenth = "";
     }
 
-    print ".SH Arguments\n";
+    print ".SH ARGUMENTS\n";
     foreach $parameter (@{$args{'parameterlist'}}) {
 	print ".IP \"".$parameter."\" 12\n";
 	output_highlight($args{'parameters'}{$parameter});
     }
     foreach $section (@{$args{'sectionlist'}}) {
-	print ".SH \"$section\"\n";
+	print ".SH \"", uc $section, "\"\n";
 	output_highlight($args{'sections'}{$section});
     }
 }
diff -uNr --exclude-from=dontdiff linux-2.4.0-test12-pre7/scripts/split-man linux/scripts/split-man
--- linux-2.4.0-test12-pre7/scripts/split-man	Thu Jan  1 01:00:00 1970
+++ linux/scripts/split-man	Fri Dec  8 22:59:07 2000
@@ -0,0 +1,33 @@
+#!/usr/bin/perl
+#
+#	split-man: create man pages from kernel-doc -man output 
+#
+# Author:	Tim Waugh <twaugh@redhat.com>
+# Modified by:	Christoph Hellwig <hch@caldera.de>
+#
+
+use strict;
+
+die "$0: where do I put the results?\n" unless ($#ARGV >= 0);
+die "$0: can't create $ARGV[0]: $!\n" unless mkdir $ARGV[0], 0777;
+
+my $state = 0;
+
+while (<STDIN>) {
+	s/&amp;(\w+)/\\fB\1\\fP/g; # fix smgl uglinesses
+	s/\$(\w+)/\\fI\1\\fP/g;
+	if (/^\.TH \"[^\"]*\" 9 \"([^\"]*)\"/) {
+		close OUT unless ($state++ == 0);
+		my $fn = "$ARGV[0]/$1.9";
+		if (open OUT, ">$fn") {
+			print STDERR "creating $fn\n";
+		} else {
+			die "can't open $fn: $!\n";
+		}
+		print OUT $_;
+	} elsif ($state != 0) {
+		print OUT $_;
+	}
+}
+
+close OUT; 
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
Please read the FAQ at http://www.tux.org/lkml/

  reply	other threads:[~2000-12-08 23:49 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2000-12-08 14:46 Networking: RFC1122 and 1123 status for kernel 2.4 Fabien Ribes
2000-12-08 14:54 ` David S. Miller
2000-12-08 15:31   ` Andi Kleen
2000-12-08 15:28     ` David S. Miller
2000-12-08 15:58       ` Andi Kleen
2000-12-08 16:41         ` kuznet
2000-12-08 16:48           ` Andi Kleen
2000-12-08 17:14             ` Alan Cox
2000-12-08 17:13           ` Alan Cox
2000-12-08 19:06             ` kuznet
2000-12-08 19:34             ` Christoph Hellwig
2000-12-08 23:17               ` Christoph Hellwig [this message]
2000-12-09  0:00               ` Alan Cox
2000-12-11 22:06         ` David S. Miller
2000-12-13 17:14           ` Fabien Ribes
2000-12-13 17:01             ` David S. Miller
2000-12-08 16:19     ` Fabien Ribes
2000-12-08 16:37       ` Andi Kleen

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=200012082317.AAA04536@ns.caldera.de \
    --to=hch@ns.caldera.de \
    --cc=ak@suse.DE \
    --cc=linux-kernel@vger.kernel.org \
    --cc=torvalds@transmeta.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.