Re: Documentation/kernel-doc-nano-HOWTO.txt

From: Andrew Morton (andrewm@uow.edu.au)
Date: Fri May 19 2000 - 20:20:17 EST


Tim Waugh wrote:
>
> On Sat, May 20, 2000 at 02:45:39AM +1000, Andrew Morton wrote:
>
> > The 'html' target does the obvious thing. It also generates an
> > appropriate symlink 'index.html' in each book's subdir. It doesn't seem
> > to be possible to determine what the actual toplevel html output file is
> > going to be called, so you have to enter this in the Makefile. :(
>
> Sure it is: just make sure all the tmpl files have 'id="index"' at the
> appropriate place.

That works well. Revised patch attached.

[ Will 'tar cvfz' get me in trouble from Mr Mastodon? ]

-- 
-akpm-

--- linux-2.3.99-pre9-1/Documentation/DocBook/Makefile Mon May 15 21:26:07 2000 +++ linux-akpm/Documentation/DocBook/Makefile Sat May 20 11:12:53 2000 @@ -1,11 +1,16 @@ -BOOKS := wanbook.sgml z8530book.sgml mcabook.sgml videobook.sgml kernel-api.sgml parportbook.sgml +BOOKS := wanbook.sgml z8530book.sgml mcabook.sgml videobook.sgml \ + kernel-api.sgml parportbook.sgml + +# Name for the HTML tarball which 'make tarball' produces +TARBALL = linux-kernel-api.tar.gz PS := $(patsubst %.sgml, %.ps, $(BOOKS)) PDF := $(patsubst %.sgml, %.pdf, $(BOOKS)) +HTML := $(patsubst %.sgml, %.html, $(BOOKS)) $(BOOKS): $(TOPDIR)/scripts/docproc -.PHONY: books ps pdf clean mrproper db2ps db2pdf +.PHONY: books ps pdf clean mrproper db2ps ps2pdf db2html books: $(BOOKS) @@ -13,6 +18,10 @@ pdf: $(PDF) +html: $(HTML) + +tarball: $(TARBALL) + db2ps db2pdf: @(which $@ > /dev/null 2>&1) || \ (echo "*** You need to install DocBook stylesheets ***"; \ @@ -65,20 +74,32 @@ AUX := $(patsubst %.sgml, %.aux, $(BOOKS)) TEX := $(patsubst %.sgml, %.tex, $(BOOKS)) LOG := $(patsubst %.sgml, %.log, $(BOOKS)) +JUNK := $(patsubst %.sgml, %.junk, $(BOOKS)) +HDIRS := $(patsubst %.sgml, %, $(BOOKS)) + +$(TARBALL): $(HTML) + chmod -R a+rX,o-w $(HDIRS) + tar cvfz $@ $(HDIRS) clean: $(RM) core *~ + $(RM) -r DBTOHTML_OUTPUT_DIR* $(RM) $(BOOKS) $(RM) $(DVI) $(AUX) $(TEX) $(LOG) + $(RM) -r $(JUNK) mrproper: clean - $(RM) $(PS) $(PDF) + $(RM) $(PS) $(PDF) $(TARBALL) + $(RM) -r $(HDIRS) %.ps : %.sgml db2ps db2ps $< -%.pdf : %.sgml - db2pdf $< +%.pdf : %.ps ps2pdf + ps2pdf $*.ps + +%.html: %.sgml db2html + db2html $< include $(TOPDIR)/Rules.make --- linux-2.3.99-pre9-1/Documentation/DocBook/kernel-api.tmpl Mon May 15 21:26:07 2000 +++ linux-akpm/Documentation/DocBook/kernel-api.tmpl Sat May 20 11:13:02 2000 @@ -1,5 +1,5 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> -<book id="LinuxKernelAPI"> +<book id="index"> <bookinfo> <title>The Linux Kernel API</title> --- linux-2.3.99-pre9-1/Documentation/DocBook/mcabook.tmpl Wed Apr 26 22:52:43 2000 +++ linux-akpm/Documentation/DocBook/mcabook.tmpl Sat May 20 11:13:05 2000 @@ -1,6 +1,6 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> -<book id="MCAGuide"> +<book id="index"> <bookinfo> <title>MCA Driver Programming Interface</title> --- linux-2.3.99-pre9-1/Documentation/DocBook/parportbook.tmpl Wed Apr 26 22:53:00 2000 +++ linux-akpm/Documentation/DocBook/parportbook.tmpl Sat May 20 11:13:09 2000 @@ -1,6 +1,6 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> -<book id="ParportGuide"> +<book id="index"> <bookinfo> <title>The Parallel Port Subsystem</title> @@ -1744,4 +1744,4 @@ </sect1> </chapter> -</book> \ No newline at end of file +</book> --- linux-2.3.99-pre9-1/Documentation/DocBook/videobook.tmpl Wed Apr 26 22:52:50 2000 +++ linux-akpm/Documentation/DocBook/videobook.tmpl Sat May 20 11:13:12 2000 @@ -1,6 +1,6 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> -<book id="V4LGuide"> +<book id="index"> <bookinfo> <title>Video4Linux Programming</title> Binary files linux-2.3.99-pre9-1/Documentation/DocBook/wanbook.html and linux-akpm/Documentation/DocBook/wanbook.html differ --- linux-2.3.99-pre9-1/Documentation/DocBook/wanbook.tmpl Wed Apr 26 22:52:43 2000 +++ linux-akpm/Documentation/DocBook/wanbook.tmpl Sat May 20 11:13:15 2000 @@ -1,6 +1,6 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> -<book id="WANGuide"> +<book id="index"> <bookinfo> <title>Synchronous PPP and Cisco HDLC Programming Guide</title> --- linux-2.3.99-pre9-1/Documentation/DocBook/z8530book.tmpl Wed Apr 26 22:52:43 2000 +++ linux-akpm/Documentation/DocBook/z8530book.tmpl Sat May 20 11:13:19 2000 @@ -1,6 +1,6 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> -<book id="Z85230Guide"> +<book id="index"> <bookinfo> <title>Z8530 Programming Guide</title>

- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.rutgers.edu Please read the FAQ at http://www.tux.org/lkml/



This archive was generated by hypermail 2b29 : Tue May 23 2000 - 21:00:18 EST