xfsdocs: add epub output
PATCH v2 1/1 xfsdocs: add epub output
Epub is a widespread open format for standalone reflowable electronic documents, and it's a core feature of Asciidoc tooling to be able to produce it, so we can get it "for free".
--- .gitignore | 1 + admin/Makefile | 13 +++++++++++-- admin/XFS_Performance_Tuning/Makefile | 13 +++++++++++-- design/Makefile | 13 +++++++++++-- design/XFS_Filesystem_Structure/Makefile | 13 +++++++++++-- 5 files changed, 45 insertions(+), 8 deletions(-)
.gitignore +1 -0
@@ -1,3 +1,4 @@ *.html *.pdf *.css +*.epub
admin/Makefile +11 -2
@@ -11,6 +11,7 @@ DOCFILES=$(wildcard *.asciidoc) HTML_TARGETS=$(addsuffix .html, $(basename $(DOCFILES))) PDF_TARGETS=$(addsuffix .pdf, $(basename $(DOCFILES))) +EPUB_TARGETS=$(addsuffix .epub, $(basename $(DOCFILES))) %.html: %.asciidoc @echo "[html] $*"
@@ -20,7 +21,11 @@ PDF_TARGETS=$(addsuffix .pdf, $(basename $(DOCFILES))) @echo "[pdf] $*" $(Q)a2x -f pdf $< -default: html pdf $(SUBDIRS) +%.epub: %.asciidoc + @echo "[epub] $*" + $(Q)a2x -f epub $< + +default: html pdf epub $(SUBDIRS) $(SUBDIRS): @echo "Building $@"
@@ -30,14 +35,18 @@ html: $(HTML_TARGETS) pdf: $(PDF_TARGETS) +epub: $(EPUB_TARGETS) + # manually construct build dependencies for target builds so that modification # of individual files will trigger a rebuild of the document correctly. $(PDF_TARGETS): $(DOCFILES) $(HTML_TARGETS): $(DOCFILES) +$(EPUB_TARGETS): $(DOCFILES) + clean: $(addsuffix -clean, $(SUBDIRS)) - $(Q)rm -f *.html *.pdf *.css + $(Q)rm -f *.html *.pdf *.css *.epub %-clean: @echo "Cleaning $*"
admin/XFS_Performance_Tuning/Makefile +11 -2
@@ -8,8 +8,9 @@ DOCFILES=$(wildcard *.asciidoc) \ HTML_TARGET=$(addsuffix .html, $(TARGET)) PDF_TARGET=$(addsuffix .pdf, $(TARGET)) +EPUB_TARGET=$(addsuffix .epub, $(TARGET)) -default: html pdf +default: html pdf epub %.html: %.asciidoc @echo "[html] $*"
@@ -19,16 +20,24 @@ default: html pdf @echo "[pdf] $*" $(Q)a2x -f pdf -d book $< +%.epub: %.asciidoc + @echo "[epub] $*" + $(Q)a2x -f epub -d book $< + html: $(HTML_TARGET) pdf: $(PDF_TARGET) +epub: $(EPUB_TARGET) + # manually construct build dependencies for target builds so that modification # of individual files will trigger a rebuild of the document correctly. $(PDF_TARGET): $(DOCFILES) $(HTML_TARGET): $(DOCFILES) +$(EPUB_TARGET): $(DOCFILES) + clean: - $(Q)rm -f *.html *.pdf *.css + $(Q)rm -f *.html *.pdf *.css *.epub
design/Makefile +11 -2
@@ -11,6 +11,7 @@ DOCFILES=$(wildcard *.asciidoc) HTML_TARGETS=$(addsuffix .html, $(basename $(DOCFILES))) PDF_TARGETS=$(addsuffix .pdf, $(basename $(DOCFILES))) +EPUB_TARGETS=$(addsuffix .epub, $(basename $(DOCFILES))) %.html: %.asciidoc @echo "[html] $*"
@@ -20,7 +21,11 @@ PDF_TARGETS=$(addsuffix .pdf, $(basename $(DOCFILES))) @echo "[pdf] $*" $(Q)a2x -f pdf --dblatex-opts "-P latex.output.revhistory=0" $< -default: html pdf $(SUBDIRS) +%.epub: %.asciidoc + @echo "[epub] $*" + $(Q)a2x -f epub $< + +default: html pdf epub $(SUBDIRS) $(SUBDIRS): @echo "Building $@"
@@ -30,14 +35,18 @@ html: $(HTML_TARGETS) pdf: $(PDF_TARGETS) +epub: $(EPUB_TARGETS) + # manually construct build dependencies for target builds so that modification # of individual files will trigger a rebuild of the document correctly. $(PDF_TARGETS): $(DOCFILES) $(HTML_TARGETS): $(DOCFILES) +$(EPUB_TARGETS): $(DOCFILES) + clean: $(addsuffix -clean, $(SUBDIRS)) - $(Q)rm -f *.html *.pdf *.css + $(Q)rm -f *.html *.pdf *.css *.epub %-clean: @echo "Cleaning $*"
design/XFS_Filesystem_Structure/Makefile +11 -2
@@ -8,8 +8,9 @@ DOCFILES=$(wildcard *.asciidoc) \ HTML_TARGET=$(addsuffix .html, $(TARGET)) PDF_TARGET=$(addsuffix .pdf, $(TARGET)) +EPUB_TARGET=$(addsuffix .epub, $(TARGET)) -default: html pdf +default: html pdf epub %.html: %.asciidoc @echo "[html] $*"
@@ -19,16 +20,24 @@ default: html pdf @echo "[pdf] $*" $(Q)a2x -f pdf -d book $< +%.epub: %.asciidoc + @echo "[epub] $*" + $(Q)a2x -f epub -d book $< + html: $(HTML_TARGET) pdf: $(PDF_TARGET) +epub: $(EPUB_TARGET) + # manually construct build dependencies for target builds so that modification # of individual files will trigger a rebuild of the document correctly. $(PDF_TARGET): $(DOCFILES) $(HTML_TARGET): $(DOCFILES) +$(EPUB_TARGET): $(DOCFILES) + clean: - $(Q)rm -f *.html *.pdf *.css + $(Q)rm -f *.html *.pdf *.css *.epub
Signature · 1 line
2.39.0
Quoted 10 lines · Csaba Henk
Epub is a widespread open format for standalone reflowable electronic documents, and it's a core feature of Asciidoc tooling to be able to produce it, so we can get it "for free".
--- .gitignore | 1 + admin/Makefile | 13 +++++++++++-- admin/XFS_Performance_Tuning/Makefile | 13 +++++++++++-- design/Makefile | 13 +++++++++++-- design/XFS_Filesystem_Structure/Makefile | 13 +++++++++++-- 5 files changed, 45 insertions(+), 8 deletions(-)
Looks fine.
Reviewed-by Dave Chinner <[email protected]>
Signature · 2 lines
Dave Chinner [email protected]
Quoted 5 lines · Csaba Henk
Epub is a widespread open format for standalone reflowable electronic documents, and it's a core feature of Asciidoc tooling to be able to produce it, so we can get it "for free".
--- .gitignore | 1 +
This patch lacks a SoB tag and on those grounds cannot be reviewed.
--D
Quoted 190 lines
admin/Makefile | 13 +++++++++++-- admin/XFS_Performance_Tuning/Makefile | 13 +++++++++++-- design/Makefile | 13 +++++++++++-- design/XFS_Filesystem_Structure/Makefile | 13 +++++++++++-- 5 files changed, 45 insertions(+), 8 deletions(-).gitignore +1
-0@@ -1,3 +1,4 @@ *.html *.pdf *.css +*.epubadmin/Makefile +11
-2@@ -11,6 +11,7 @@ DOCFILES=$(wildcard *.asciidoc) HTML_TARGETS=$(addsuffix .html, $(basename $(DOCFILES))) PDF_TARGETS=$(addsuffix .pdf, $(basename $(DOCFILES))) +EPUB_TARGETS=$(addsuffix .epub, $(basename $(DOCFILES))) %.html: %.asciidoc @echo "[html] $*"@@ -20,7 +21,11 @@ PDF_TARGETS=$(addsuffix .pdf, $(basename $(DOCFILES))) @echo "[pdf] $*" $(Q)a2x -f pdf $< -default: html pdf $(SUBDIRS) +%.epub: %.asciidoc + @echo "[epub] $*" + $(Q)a2x -f epub $< + +default: html pdf epub $(SUBDIRS) $(SUBDIRS): @echo "Building $@"@@ -30,14 +35,18 @@ html: $(HTML_TARGETS) pdf: $(PDF_TARGETS) +epub: $(EPUB_TARGETS) + # manually construct build dependencies for target builds so that modification # of individual files will trigger a rebuild of the document correctly. $(PDF_TARGETS): $(DOCFILES) $(HTML_TARGETS): $(DOCFILES) +$(EPUB_TARGETS): $(DOCFILES) + clean: $(addsuffix -clean, $(SUBDIRS)) - $(Q)rm -f *.html *.pdf *.css + $(Q)rm -f *.html *.pdf *.css *.epub %-clean: @echo "Cleaning $*"admin/XFS_Performance_Tuning/Makefile +11
-2@@ -8,8 +8,9 @@ DOCFILES=$(wildcard *.asciidoc) \ HTML_TARGET=$(addsuffix .html, $(TARGET)) PDF_TARGET=$(addsuffix .pdf, $(TARGET)) +EPUB_TARGET=$(addsuffix .epub, $(TARGET)) -default: html pdf +default: html pdf epub %.html: %.asciidoc @echo "[html] $*"@@ -19,16 +20,24 @@ default: html pdf @echo "[pdf] $*" $(Q)a2x -f pdf -d book $< +%.epub: %.asciidoc + @echo "[epub] $*" + $(Q)a2x -f epub -d book $< + html: $(HTML_TARGET) pdf: $(PDF_TARGET) +epub: $(EPUB_TARGET) + # manually construct build dependencies for target builds so that modification # of individual files will trigger a rebuild of the document correctly. $(PDF_TARGET): $(DOCFILES) $(HTML_TARGET): $(DOCFILES) +$(EPUB_TARGET): $(DOCFILES) + clean: - $(Q)rm -f *.html *.pdf *.css + $(Q)rm -f *.html *.pdf *.css *.epubdesign/Makefile +11
-2@@ -11,6 +11,7 @@ DOCFILES=$(wildcard *.asciidoc) HTML_TARGETS=$(addsuffix .html, $(basename $(DOCFILES))) PDF_TARGETS=$(addsuffix .pdf, $(basename $(DOCFILES))) +EPUB_TARGETS=$(addsuffix .epub, $(basename $(DOCFILES))) %.html: %.asciidoc @echo "[html] $*"@@ -20,7 +21,11 @@ PDF_TARGETS=$(addsuffix .pdf, $(basename $(DOCFILES))) @echo "[pdf] $*" $(Q)a2x -f pdf --dblatex-opts "-P latex.output.revhistory=0" $< -default: html pdf $(SUBDIRS) +%.epub: %.asciidoc + @echo "[epub] $*" + $(Q)a2x -f epub $< + +default: html pdf epub $(SUBDIRS) $(SUBDIRS): @echo "Building $@"@@ -30,14 +35,18 @@ html: $(HTML_TARGETS) pdf: $(PDF_TARGETS) +epub: $(EPUB_TARGETS) + # manually construct build dependencies for target builds so that modification # of individual files will trigger a rebuild of the document correctly. $(PDF_TARGETS): $(DOCFILES) $(HTML_TARGETS): $(DOCFILES) +$(EPUB_TARGETS): $(DOCFILES) + clean: $(addsuffix -clean, $(SUBDIRS)) - $(Q)rm -f *.html *.pdf *.css + $(Q)rm -f *.html *.pdf *.css *.epub %-clean: @echo "Cleaning $*"design/XFS_Filesystem_Structure/Makefile +11
-2@@ -8,8 +8,9 @@ DOCFILES=$(wildcard *.asciidoc) \ HTML_TARGET=$(addsuffix .html, $(TARGET)) PDF_TARGET=$(addsuffix .pdf, $(TARGET)) +EPUB_TARGET=$(addsuffix .epub, $(TARGET)) -default: html pdf +default: html pdf epub %.html: %.asciidoc @echo "[html] $*"@@ -19,16 +20,24 @@ default: html pdf @echo "[pdf] $*" $(Q)a2x -f pdf -d book $< +%.epub: %.asciidoc + @echo "[epub] $*" + $(Q)a2x -f epub -d book $< + html: $(HTML_TARGET) pdf: $(PDF_TARGET) +epub: $(EPUB_TARGET) + # manually construct build dependencies for target builds so that modification # of individual files will trigger a rebuild of the document correctly. $(PDF_TARGET): $(DOCFILES) $(HTML_TARGET): $(DOCFILES) +$(EPUB_TARGET): $(DOCFILES) + clean: - $(Q)rm -f *.html *.pdf *.css + $(Q)rm -f *.html *.pdf *.css *.epubSignature · 1 line
2.39.0