From ac9296f95228f50d112e6caec3b461fd816de084 Mon Sep 17 00:00:00 2001 From: Jeff Garzik Date: Sun, 1 May 2005 08:59:27 -0700 Subject: [PATCH] DocBook: remove obsolete templates As the author of tulip-user and via-audio docbooks, I can say that they are out of date and should be deleted. Signed-off-by: Martin Waitz Signed-off-by: Andrew Morton Signed-off-by: Linus Torvalds --- Documentation/DocBook/Makefile | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) (limited to 'Documentation/DocBook/Makefile') diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile index a221039ee4c..393082c7a3a 100644 --- a/Documentation/DocBook/Makefile +++ b/Documentation/DocBook/Makefile @@ -7,10 +7,9 @@ # list of DOCBOOKS. DOCBOOKS := wanbook.xml z8530book.xml mcabook.xml videobook.xml \ - kernel-hacking.xml kernel-locking.xml via-audio.xml \ - deviceiobook.xml procfs-guide.xml tulip-user.xml \ - writing_usb_driver.xml scsidrivers.xml sis900.xml \ - kernel-api.xml journal-api.xml lsm.xml usb.xml \ + kernel-hacking.xml kernel-locking.xml deviceiobook.xml \ + procfs-guide.xml writing_usb_driver.xml scsidrivers.xml \ + sis900.xml kernel-api.xml journal-api.xml lsm.xml usb.xml \ gadget.xml libata.xml mtdnand.xml librs.xml ### -- cgit v1.2.3 From 8b0c2d989cc60db1767481386ca912e99807eddb Mon Sep 17 00:00:00 2001 From: Martin Waitz Date: Sun, 1 May 2005 08:59:27 -0700 Subject: [PATCH] DocBook: Use xmlto to process the DocBook files. xmlto uses standared XSLT templates to generate manpages, (x)html pages, and XML FO files which can be processed with passivetex. This is much faster than using jadetex for everything. This patch also reduces the number of kernel-specific scripts that are needed to generate documentation. Signed-off-by: Martin Waitz Signed-off-by: Andrew Morton Signed-off-by: Linus Torvalds --- Documentation/DocBook/Makefile | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) (limited to 'Documentation/DocBook/Makefile') diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile index 393082c7a3a..a2441fa99c3 100644 --- a/Documentation/DocBook/Makefile +++ b/Documentation/DocBook/Makefile @@ -41,14 +41,15 @@ MAN := $(patsubst %.xml, %.9, $(BOOKS)) mandocs: $(MAN) installmandocs: mandocs - $(MAKEMAN) install Documentation/DocBook/man + mkdir -p /usr/local/man/man9/ + install Documentation/DocBook/man/*.9.gz /usr/local/man/man9/ ### #External programs used KERNELDOC = scripts/kernel-doc DOCPROC = scripts/basic/docproc -SPLITMAN = $(PERL) $(srctree)/scripts/split-man -MAKEMAN = $(PERL) $(srctree)/scripts/makeman + +#XMLTOFLAGS = --skip-validation ### # DOCPROC is used for two purposes: @@ -95,29 +96,29 @@ $(obj)/procfs-guide.xml: $(C-procfs-example2) # Rules to generate postscript, PDF and HTML # db2html creates a directory. Generate a html file used for timestamp -quiet_cmd_db2ps = DB2PS $@ - cmd_db2ps = db2ps -o $(dir $@) $< +quiet_cmd_db2ps = XMLTO $@ + cmd_db2ps = xmlto ps $(XMLTOFLAGS) -o $(dir $@) $< %.ps : %.xml - @(which db2ps > /dev/null 2>&1) || \ + @(which xmlto > /dev/null 2>&1) || \ (echo "*** You need to install DocBook stylesheets ***"; \ exit 1) $(call cmd,db2ps) -quiet_cmd_db2pdf = DB2PDF $@ - cmd_db2pdf = db2pdf -o $(dir $@) $< +quiet_cmd_db2pdf = XMLTO $@ + cmd_db2pdf = xmlto pdf $(XMLTOFLAGS) -o $(dir $@) $< %.pdf : %.xml - @(which db2pdf > /dev/null 2>&1) || \ + @(which xmlto > /dev/null 2>&1) || \ (echo "*** You need to install DocBook stylesheets ***"; \ exit 1) $(call cmd,db2pdf) -quiet_cmd_db2html = DB2HTML $@ - cmd_db2html = db2html -o $(patsubst %.html,%,$@) $< && \ +quiet_cmd_db2html = XMLTO $@ + cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \ echo ' \ Goto $(patsubst %.html,%,$(notdir $@))

' > $@ %.html: %.xml - @(which db2html > /dev/null 2>&1) || \ + @(which xmlto > /dev/null 2>&1) || \ (echo "*** You need to install DocBook stylesheets ***"; \ exit 1) @rm -rf $@ $(patsubst %.html,%,$@) @@ -125,15 +126,14 @@ quiet_cmd_db2html = DB2HTML $@ @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \ cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi -### -# Rule to generate man files - output is placed in the man subdirectory - -%.9: %.xml -ifneq ($(KBUILD_SRC),) - $(Q)mkdir -p $(objtree)/Documentation/DocBook/man -endif - $(SPLITMAN) $< $(objtree)/Documentation/DocBook/man "$(VERSION).$(PATCHLEVEL).$(SUBLEVEL)" - $(MAKEMAN) convert $(objtree)/Documentation/DocBook/man $< +quiet_cmd_db2man = XMLTO $@ + cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; gzip -f $(obj)/man/*.9; fi +%.9 : %.xml + @(which xmlto > /dev/null 2>&1) || \ + (echo "*** You need to install DocBook stylesheets ***"; \ + exit 1) + $(call cmd,db2man) + @touch $@ ### # Rules to generate postscripts and PNG imgages from .fig format files -- cgit v1.2.3 From 2948e57d94bd2d2fb6d4e89d89f0bd0ddaee0513 Mon Sep 17 00:00:00 2001 From: Martin Waitz Date: Sun, 1 May 2005 08:59:27 -0700 Subject: [PATCH] Docbook: use custom stylesheet With the custom stylesheet, functions are rendered using ANSI-C syntax and xmlto is a bit quieter. Signed-off-by: Martin Waitz Signed-off-by: Andrew Morton Signed-off-by: Linus Torvalds --- Documentation/DocBook/Makefile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'Documentation/DocBook/Makefile') diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile index a2441fa99c3..39c87666db3 100644 --- a/Documentation/DocBook/Makefile +++ b/Documentation/DocBook/Makefile @@ -49,7 +49,8 @@ installmandocs: mandocs KERNELDOC = scripts/kernel-doc DOCPROC = scripts/basic/docproc -#XMLTOFLAGS = --skip-validation +XMLTOFLAGS = -m Documentation/DocBook/stylesheet.xsl +#XMLTOFLAGS += --skip-validation ### # DOCPROC is used for two purposes: -- cgit v1.2.3 From 4fa35166c540073a2c6e450683c776f68e8b5569 Mon Sep 17 00:00:00 2001 From: Martin Waitz Date: Sun, 1 May 2005 08:59:28 -0700 Subject: [PATCH] DocBook: fix html link The start page for each book has changed from book1.html to index.html. Update our generated links acocrdingly. Signed-off-by: Martin Waitz Signed-off-by: Andrew Morton Signed-off-by: Linus Torvalds --- Documentation/DocBook/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/DocBook/Makefile') diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile index 39c87666db3..83bcb0ae091 100644 --- a/Documentation/DocBook/Makefile +++ b/Documentation/DocBook/Makefile @@ -115,7 +115,7 @@ quiet_cmd_db2pdf = XMLTO $@ quiet_cmd_db2html = XMLTO $@ cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \ - echo ' \ + echo ' \ Goto $(patsubst %.html,%,$(notdir $@))

' > $@ %.html: %.xml -- cgit v1.2.3 From fd4a3244941ed74fffc24b64857977270e6f64e2 Mon Sep 17 00:00:00 2001 From: Sam Ravnborg Date: Sun, 1 May 2005 08:59:28 -0700 Subject: [PATCH] docbook: Tell users to install xmlto, not stylesheets We have at least two users which were confused by these messages, myself included. Signed-off-by: Alexey Dobriyan Signed-off-by: Sam Ravnborg Signed-off-by: Andrew Morton Signed-off-by: Linus Torvalds --- Documentation/DocBook/Makefile | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'Documentation/DocBook/Makefile') diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile index 83bcb0ae091..e69b3d2e788 100644 --- a/Documentation/DocBook/Makefile +++ b/Documentation/DocBook/Makefile @@ -101,7 +101,7 @@ quiet_cmd_db2ps = XMLTO $@ cmd_db2ps = xmlto ps $(XMLTOFLAGS) -o $(dir $@) $< %.ps : %.xml @(which xmlto > /dev/null 2>&1) || \ - (echo "*** You need to install DocBook stylesheets ***"; \ + (echo "*** You need to install xmlto ***"; \ exit 1) $(call cmd,db2ps) @@ -109,7 +109,7 @@ quiet_cmd_db2pdf = XMLTO $@ cmd_db2pdf = xmlto pdf $(XMLTOFLAGS) -o $(dir $@) $< %.pdf : %.xml @(which xmlto > /dev/null 2>&1) || \ - (echo "*** You need to install DocBook stylesheets ***"; \ + (echo "*** You need to install xmlto ***"; \ exit 1) $(call cmd,db2pdf) @@ -120,7 +120,7 @@ quiet_cmd_db2html = XMLTO $@ %.html: %.xml @(which xmlto > /dev/null 2>&1) || \ - (echo "*** You need to install DocBook stylesheets ***"; \ + (echo "*** You need to install xmlto ***"; \ exit 1) @rm -rf $@ $(patsubst %.html,%,$@) $(call cmd,db2html) @@ -131,7 +131,7 @@ quiet_cmd_db2man = XMLTO $@ cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; gzip -f $(obj)/man/*.9; fi %.9 : %.xml @(which xmlto > /dev/null 2>&1) || \ - (echo "*** You need to install DocBook stylesheets ***"; \ + (echo "*** You need to install xmlto ***"; \ exit 1) $(call cmd,db2man) @touch $@ -- cgit v1.2.3