* [PATCH v3] xfsdocs: add epub output
@ 2023-01-18 0:14 Csaba Henk
2023-01-18 0:47 ` Darrick J. Wong
0 siblings, 1 reply; 2+ messages in thread
From: Csaba Henk @ 2023-01-18 0:14 UTC (permalink / raw)
To: linux-xfs; +Cc: Dave Chinner, Darrick J. Wong
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".
Signed-off-by: Csaba Henk <chenk@redhat.com>
---
Delivering SoB that was missing from v2.
.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
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH v3] xfsdocs: add epub output
2023-01-18 0:14 [PATCH v3] xfsdocs: add epub output Csaba Henk
@ 2023-01-18 0:47 ` Darrick J. Wong
0 siblings, 0 replies; 2+ messages in thread
From: Darrick J. Wong @ 2023-01-18 0:47 UTC (permalink / raw)
To: Csaba Henk; +Cc: linux-xfs, Dave Chinner
On Wed, Jan 18, 2023 at 01:14:08AM +0100, Csaba Henk wrote:
> 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".
>
> Signed-off-by: Csaba Henk <chenk@redhat.com>
Looks good, thank you for correcting that oversight!
Reviewed-by: Darrick J. Wong <djwong@kernel.org>
--D
> ---
> Delivering SoB that was missing from v2.
>
> .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
>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2023-01-18 0:59 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-01-18 0:14 [PATCH v3] xfsdocs: add epub output Csaba Henk
2023-01-18 0:47 ` Darrick J. Wong
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox