diff mbox series

[v2] xfsdocs: add epub output

Message ID 20230116201258.a4debvbbbr724ilm@nixos (mailing list archive)
State Superseded
Headers show
Series [v2] xfsdocs: add epub output | expand

Commit Message

Csaba Henk Jan. 16, 2023, 8:12 p.m. UTC
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(-)

Comments

Dave Chinner Jan. 17, 2023, 1:08 a.m. UTC | #1
On Mon, Jan 16, 2023 at 09:12:58PM +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".
> ---
>  .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 <dchinner@redhat.com>
Darrick J. Wong Jan. 17, 2023, 11:36 p.m. UTC | #2
On Mon, Jan 16, 2023 at 09:12:58PM +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".
> ---
>  .gitignore                               |  1 +

This patch lacks a SoB tag and on those grounds cannot be reviewed.

--D

>  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
>
diff mbox series

Patch

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