Skip to content

L
linux
Commit f326b3fc authored by Martin Waitz's avatar Martin Waitz Committed by Linus Torvalds
Browse files
Options

[PATCH] docbook: s/sgml/xml/ in Documentation/DocBook/Makefile 

s/sgml/xml/ in Documentation/DocBook/Makefile
Signed-off-by: default avatarMartin Waitz <tali@admingilde.org>
Signed-off-by: default avatarAndrew Morton <akpm@osdl.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@osdl.org>
parent e3937044
Hide whitespace changes
Inline Side-by-side
Showing with 39 additions and 38 deletions
Documentation/DocBook/Makefile
View file @ f326b3fc
...@@ -6,38 +6,39 @@ ...@@ -6,38 +6,39 @@
# To add a new book the only step required is to add the book to the # To add a new book the only step required is to add the book to the
# list of DOCBOOKS. # list of DOCBOOKS.
DOCBOOKS := wanbook.sgml z8530book.sgml mcabook.sgml videobook.sgml \ DOCBOOKS := wanbook.xml z8530book.xml mcabook.xml videobook.xml \
kernel-hacking.sgml kernel-locking.sgml via-audio.sgml \ kernel-hacking.xml kernel-locking.xml via-audio.xml \
deviceiobook.sgml procfs-guide.sgml tulip-user.sgml \ deviceiobook.xml procfs-guide.xml tulip-user.xml \
writing_usb_driver.sgml scsidrivers.sgml sis900.sgml \ writing_usb_driver.xml scsidrivers.xml sis900.xml \
kernel-api.sgml journal-api.sgml lsm.sgml usb.sgml \ kernel-api.xml journal-api.xml lsm.xml usb.xml \
gadget.sgml libata.sgml mtdnand.sgml librs.sgml gadget.xml libata.xml mtdnand.xml librs.xml
### ###
# The build process is as follows (targets): # The build process is as follows (targets):
# (sgmldocs) # (xmldocs)
# file.tmpl --> file.sgml +--> file.ps (psdocs) # file.tmpl --> file.xml +--> file.ps (psdocs)
# +--> file.pdf (pdfdocs) # +--> file.pdf (pdfdocs)
# +--> DIR=file (htmldocs) # +--> DIR=file (htmldocs)
# +--> man/ (mandocs) # +--> man/ (mandocs)
### ###
# The targets that may be used. # The targets that may be used.
.PHONY: sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs .PHONY: xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs
BOOKS := $(addprefix $(obj)/,$(DOCBOOKS)) BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
sgmldocs: $(BOOKS) xmldocs: $(BOOKS)
sgmldocs: xmldocs
PS := $(patsubst %.sgml, %.ps, $(BOOKS)) PS := $(patsubst %.xml, %.ps, $(BOOKS))
psdocs: $(PS) psdocs: $(PS)
PDF := $(patsubst %.sgml, %.pdf, $(BOOKS)) PDF := $(patsubst %.xml, %.pdf, $(BOOKS))
pdfdocs: $(PDF) pdfdocs: $(PDF)
HTML := $(patsubst %.sgml, %.html, $(BOOKS)) HTML := $(patsubst %.xml, %.html, $(BOOKS))
htmldocs: $(HTML) htmldocs: $(HTML)
MAN := $(patsubst %.sgml, %.9, $(BOOKS)) MAN := $(patsubst %.xml, %.9, $(BOOKS))
mandocs: $(MAN) mandocs: $(MAN)
installmandocs: mandocs installmandocs: mandocs
...@@ -55,7 +56,7 @@ MAKEMAN = $(PERL) $(srctree)/scripts/makeman ...@@ -55,7 +56,7 @@ MAKEMAN = $(PERL) $(srctree)/scripts/makeman
# 1) To generate a dependency list for a .tmpl file # 1) To generate a dependency list for a .tmpl file
# 2) To preprocess a .tmpl file and call kernel-doc with # 2) To preprocess a .tmpl file and call kernel-doc with
# appropriate parameters. # appropriate parameters.
# The following rules are used to generate the .sgml documentation # The following rules are used to generate the .xml documentation
# required to generate the final targets. (ps, pdf, html). # required to generate the final targets. (ps, pdf, html).
quiet_cmd_docproc = DOCPROC $@ quiet_cmd_docproc = DOCPROC $@
cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@ cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@
...@@ -69,7 +70,7 @@ define rule_docproc ...@@ -69,7 +70,7 @@ define rule_docproc
) > $(dir $@).$(notdir $@).cmd ) > $(dir $@).$(notdir $@).cmd
endef endef
%.sgml: %.tmpl FORCE %.xml: %.tmpl FORCE
$(call if_changed_rule,docproc) $(call if_changed_rule,docproc)
### ###
...@@ -87,9 +88,9 @@ $(BOOKS): $(KERNELDOC) ...@@ -87,9 +88,9 @@ $(BOOKS): $(KERNELDOC)
### ###
# procfs guide uses a .c file as example code. # procfs guide uses a .c file as example code.
# This requires an explicit dependency # This requires an explicit dependency
C-procfs-example = procfs_example.sgml C-procfs-example = procfs_example.xml
C-procfs-example2 = $(addprefix $(obj)/,$(C-procfs-example)) C-procfs-example2 = $(addprefix $(obj)/,$(C-procfs-example))
$(obj)/procfs-guide.sgml: $(C-procfs-example2) $(obj)/procfs-guide.xml: $(C-procfs-example2)
### ###
# Rules to generate postscript, PDF and HTML # Rules to generate postscript, PDF and HTML
...@@ -97,7 +98,7 @@ $(obj)/procfs-guide.sgml: $(C-procfs-example2) ...@@ -97,7 +98,7 @@ $(obj)/procfs-guide.sgml: $(C-procfs-example2)
quiet_cmd_db2ps = DB2PS $@ quiet_cmd_db2ps = DB2PS $@
cmd_db2ps = db2ps -o $(dir $@) $< cmd_db2ps = db2ps -o $(dir $@) $<
%.ps : %.sgml %.ps : %.xml
@(which db2ps > /dev/null 2>&1) || \ @(which db2ps > /dev/null 2>&1) || \
(echo "*** You need to install DocBook stylesheets ***"; \ (echo "*** You need to install DocBook stylesheets ***"; \
exit 1) exit 1)
...@@ -105,7 +106,7 @@ quiet_cmd_db2ps = DB2PS $@ ...@@ -105,7 +106,7 @@ quiet_cmd_db2ps = DB2PS $@
quiet_cmd_db2pdf = DB2PDF $@ quiet_cmd_db2pdf = DB2PDF $@
cmd_db2pdf = db2pdf -o $(dir $@) $< cmd_db2pdf = db2pdf -o $(dir $@) $<
%.pdf : %.sgml %.pdf : %.xml
@(which db2pdf > /dev/null 2>&1) || \ @(which db2pdf > /dev/null 2>&1) || \
(echo "*** You need to install DocBook stylesheets ***"; \ (echo "*** You need to install DocBook stylesheets ***"; \
exit 1) exit 1)
...@@ -116,7 +117,7 @@ quiet_cmd_db2html = DB2HTML $@ ...@@ -116,7 +117,7 @@ quiet_cmd_db2html = DB2HTML $@
echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/book1.html"> \ echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/book1.html"> \
Goto $(patsubst %.html,%,$(notdir $@))</a><p>' > $@ Goto $(patsubst %.html,%,$(notdir $@))</a><p>' > $@
%.html: %.sgml %.html: %.xml
@(which db2html > /dev/null 2>&1) || \ @(which db2html > /dev/null 2>&1) || \
(echo "*** You need to install DocBook stylesheets ***"; \ (echo "*** You need to install DocBook stylesheets ***"; \
exit 1) exit 1)
...@@ -128,7 +129,7 @@ quiet_cmd_db2html = DB2HTML $@ ...@@ -128,7 +129,7 @@ quiet_cmd_db2html = DB2HTML $@
### ###
# Rule to generate man files - output is placed in the man subdirectory # Rule to generate man files - output is placed in the man subdirectory
%.9: %.sgml %.9: %.xml
ifneq ($(KBUILD_SRC),) ifneq ($(KBUILD_SRC),)
$(Q)mkdir -p $(objtree)/Documentation/DocBook/man $(Q)mkdir -p $(objtree)/Documentation/DocBook/man
endif endif
...@@ -156,8 +157,8 @@ quiet_cmd_fig2png = FIG2PNG $@ ...@@ -156,8 +157,8 @@ quiet_cmd_fig2png = FIG2PNG $@
$(call cmd,fig2png) $(call cmd,fig2png)
### ###
# Rule to convert a .c file to inline SGML documentation # Rule to convert a .c file to inline XML documentation
%.sgml: %.c %.xml: %.c
@echo ' GEN $@' @echo ' GEN $@'
@( \ @( \
echo "<programlisting>"; \ echo "<programlisting>"; \
...@@ -171,24 +172,24 @@ quiet_cmd_fig2png = FIG2PNG $@ ...@@ -171,24 +172,24 @@ quiet_cmd_fig2png = FIG2PNG $@
# Help targets as used by the top-level makefile # Help targets as used by the top-level makefile
dochelp: dochelp:
@echo ' Linux kernel internal documentation in different formats:' @echo ' Linux kernel internal documentation in different formats:'
@echo ' sgmldocs (SGML), psdocs (Postscript), pdfdocs (PDF)' @echo ' xmldocs (XML DocBook), psdocs (Postscript), pdfdocs (PDF)'
@echo ' htmldocs (HTML), mandocs (man pages, use installmandocs to install)' @echo ' htmldocs (HTML), mandocs (man pages, use installmandocs to install)'
### ###
# Temporary files left by various tools # Temporary files left by various tools
clean-files := $(DOCBOOKS) \ clean-files := $(DOCBOOKS) \
$(patsubst %.sgml, %.dvi, $(DOCBOOKS)) \ $(patsubst %.xml, %.dvi, $(DOCBOOKS)) \
$(patsubst %.sgml, %.aux, $(DOCBOOKS)) \ $(patsubst %.xml, %.aux, $(DOCBOOKS)) \
$(patsubst %.sgml, %.tex, $(DOCBOOKS)) \ $(patsubst %.xml, %.tex, $(DOCBOOKS)) \
$(patsubst %.sgml, %.log, $(DOCBOOKS)) \ $(patsubst %.xml, %.log, $(DOCBOOKS)) \
$(patsubst %.sgml, %.out, $(DOCBOOKS)) \ $(patsubst %.xml, %.out, $(DOCBOOKS)) \
$(patsubst %.sgml, %.ps, $(DOCBOOKS)) \ $(patsubst %.xml, %.ps, $(DOCBOOKS)) \
$(patsubst %.sgml, %.pdf, $(DOCBOOKS)) \ $(patsubst %.xml, %.pdf, $(DOCBOOKS)) \
$(patsubst %.sgml, %.html, $(DOCBOOKS)) \ $(patsubst %.xml, %.html, $(DOCBOOKS)) \
$(patsubst %.sgml, %.9, $(DOCBOOKS)) \ $(patsubst %.xml, %.9, $(DOCBOOKS)) \
$(C-procfs-example) $(C-procfs-example)
clean-dirs := $(patsubst %.sgml,%,$(DOCBOOKS)) clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS))
#man put files in man subdir - traverse down #man put files in man subdir - traverse down
subdir- := man/ subdir- := man/
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7