From: Csaba Henk <chenk@redhat.com>
To: linux-xfs@vger.kernel.org
Cc: Dave Chinner <david@fromorbit.com>,
"Darrick J. Wong" <djwong@kernel.org>
Subject: [PATCH v2] xfsdocs: add epub output
Date: Mon, 16 Jan 2023 21:12:58 +0100 [thread overview]
Message-ID: <20230116201258.a4debvbbbr724ilm@nixos> (raw)
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(-)
diff --git a/.gitignore b/.gitignore
index a2e10b4..412ff1c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
*.html
*.pdf
*.css
+*.epub
diff --git a/admin/Makefile b/admin/Makefile
index de27f3b..dcffc63 100644
--- a/admin/Makefile
+++ b/admin/Makefile
@@ -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 $*"
diff --git a/admin/XFS_Performance_Tuning/Makefile b/admin/XFS_Performance_Tuning/Makefile
index 06451f1..2b929a4 100644
--- a/admin/XFS_Performance_Tuning/Makefile
+++ b/admin/XFS_Performance_Tuning/Makefile
@@ -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
diff --git a/design/Makefile b/design/Makefile
index 0879470..0847896 100644
--- a/design/Makefile
+++ b/design/Makefile
@@ -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 $*"
diff --git a/design/XFS_Filesystem_Structure/Makefile b/design/XFS_Filesystem_Structure/Makefile
index 359dd98..be78a75 100644
--- a/design/XFS_Filesystem_Structure/Makefile
+++ b/design/XFS_Filesystem_Structure/Makefile
@@ -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
--
2.39.0
next reply other threads:[~2023-01-16 20:14 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-16 20:12 Csaba Henk [this message]
2023-01-17 1:08 ` [PATCH v2] xfsdocs: add epub output Dave Chinner
2023-01-17 23:36 ` Darrick J. Wong
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=20230116201258.a4debvbbbr724ilm@nixos \
--to=chenk@redhat.com \
--cc=david@fromorbit.com \
--cc=djwong@kernel.org \
--cc=linux-xfs@vger.kernel.org \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox