threads / patch / 46276

patchsubtree: Obey USE_ASCIIDOCTOR when present

Subject: [PATCH] subtree: Obey USE_ASCIIDOCTOR when present

## tl;dr

2 messages between Jun 28, 2017 and Jun 28, 2017. Diffs are folded; open one to read it.

replies: 1people: 2as markdown or json

A. Wilcox· Jun 28, 2017, 02:49 UTC · lore

Defining USE_ASCIIDOCTOR=1 when building Git uses asciidoctor over asciidoc when generating DocBook and man page documentation. However, the contrib/subtree module does not presently honour that flag.

This causes a build failure when asciidoc is not present on the build system. Instead, adapt the main Documentation/Makefile logic to use asciidoctor when requested.

Signed-off-by: A. Wilcox <AWilcox@Wilcox-Tech.com>
---
 contrib/subtree/Makefile | 26 +++++++++++++++++++-------
 1 file changed, 19 insertions(+), 7 deletions(-)

Show changes to contrib/subtree/Makefile +19 −7

diff --git a/contrib/subtree/Makefile b/contrib/subtree/Makefile
index 6afa9aa..1b8fcd1 100644
--- a/contrib/subtree/Makefile
+++ b/contrib/subtree/Makefile
@@ -19,15 +19,27 @@ htmldir ?= $(prefix)/share/doc/git-doc
 INSTALL  ?= install
 RM       ?= rm -f
 
-ASCIIDOC = asciidoc
-XMLTO    = xmlto
+ASCIIDOC         = asciidoc
+ASCIIDOC_CONF    = -f ../../Documentation/asciidoc.conf
+ASCIIDOC_HTML    = xhtml11
+ASCIIDOC_DOCBOOK = docbook
+ASCIIDOC_EXTRA   = 
+XMLTO            = xmlto
+
+ifdef USE_ASCIIDOCTOR
+ASCIIDOC         = asciidoctor
+ASCIIDOC_CONF    =
+ASCIIDOC_HTML    = xhtml5
+ASCIIDOC_DOCBOOK = docbook45
+ASCIIDOC_EXTRA  += -I../../Documentation -rasciidoctor-extensions
+ASCIIDOC_EXTRA  += -alitdd='&\#x2d;&\#x2d;'
+endif
 
 ifndef SHELL_PATH
 	SHELL_PATH = /bin/sh
 endif
 SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
 
-ASCIIDOC_CONF = ../../Documentation/asciidoc.conf
 MANPAGE_XSL   = ../../Documentation/manpage-normal.xsl
 
 GIT_SUBTREE_SH := git-subtree.sh
@@ -65,12 +77,12 @@ $(GIT_SUBTREE_DOC): $(GIT_SUBTREE_XML)
 	$(XMLTO) -m $(MANPAGE_XSL) man $^
 
 $(GIT_SUBTREE_XML): $(GIT_SUBTREE_TXT)
-	$(ASCIIDOC) -b docbook -d manpage -f $(ASCIIDOC_CONF) \
-		-agit_version=$(GIT_VERSION) $^
+	$(ASCIIDOC) -b $(ASCIIDOC_DOCBOOK) -d manpage $(ASCIIDOC_CONF) \
+		-agit_version=$(GIT_VERSION) $(ASCIIDOC_EXTRA) $^
 
 $(GIT_SUBTREE_HTML): $(GIT_SUBTREE_TXT)
-	$(ASCIIDOC) -b xhtml11 -d manpage -f $(ASCIIDOC_CONF) \
-		-agit_version=$(GIT_VERSION) $^
+	$(ASCIIDOC) -b $(ASCIIDOC_HTML) -d manpage $(ASCIIDOC_CONF) \
+		-agit_version=$(GIT_VERSION) $(ASCIIDOC_EXTRA) $^
 
 $(GIT_SUBTREE_TEST): $(GIT_SUBTREE)
 	cp $< $@

-- 
2.10.0

Junio C Hamano· Jun 28, 2017, 03:57 UTC · re: A. Wilcox · lore

Re: [PATCH] subtree: Obey USE_ASCIIDOCTOR when present

"A. Wilcox" <AWilcox@Wilcox-Tech.com> writes:

Show 10 quoted lines

> Defining USE_ASCIIDOCTOR=1 when building Git uses asciidoctor over
> asciidoc when generating DocBook and man page documentation.  However,
> the contrib/subtree module does not presently honour that flag.
>
> This causes a build failure when asciidoc is not present on the build
> system.  Instead, adapt the main Documentation/Makefile logic to use
> asciidoctor when requested.
>
> Signed-off-by: A. Wilcox <AWilcox@Wilcox-Tech.com>
> ---

Makes sense.  Thanks.  Will queue.

Show 55 quoted lines

>  contrib/subtree/Makefile | 26 +++++++++++++++++++-------
>  1 file changed, 19 insertions(+), 7 deletions(-)
>
> diff --git a/contrib/subtree/Makefile b/contrib/subtree/Makefile
> index 6afa9aa..1b8fcd1 100644
> --- a/contrib/subtree/Makefile
> +++ b/contrib/subtree/Makefile
> @@ -19,15 +19,27 @@ htmldir ?= $(prefix)/share/doc/git-doc
>  INSTALL  ?= install
>  RM       ?= rm -f
>  
> -ASCIIDOC = asciidoc
> -XMLTO    = xmlto
> +ASCIIDOC         = asciidoc
> +ASCIIDOC_CONF    = -f ../../Documentation/asciidoc.conf
> +ASCIIDOC_HTML    = xhtml11
> +ASCIIDOC_DOCBOOK = docbook
> +ASCIIDOC_EXTRA   = 
> +XMLTO            = xmlto
> +
> +ifdef USE_ASCIIDOCTOR
> +ASCIIDOC         = asciidoctor
> +ASCIIDOC_CONF    =
> +ASCIIDOC_HTML    = xhtml5
> +ASCIIDOC_DOCBOOK = docbook45
> +ASCIIDOC_EXTRA  += -I../../Documentation -rasciidoctor-extensions
> +ASCIIDOC_EXTRA  += -alitdd='&\#x2d;&\#x2d;'
> +endif
>  
>  ifndef SHELL_PATH
>  	SHELL_PATH = /bin/sh
>  endif
>  SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
>  
> -ASCIIDOC_CONF = ../../Documentation/asciidoc.conf
>  MANPAGE_XSL   = ../../Documentation/manpage-normal.xsl
>  
>  GIT_SUBTREE_SH := git-subtree.sh
> @@ -65,12 +77,12 @@ $(GIT_SUBTREE_DOC): $(GIT_SUBTREE_XML)
>  	$(XMLTO) -m $(MANPAGE_XSL) man $^
>  
>  $(GIT_SUBTREE_XML): $(GIT_SUBTREE_TXT)
> -	$(ASCIIDOC) -b docbook -d manpage -f $(ASCIIDOC_CONF) \
> -		-agit_version=$(GIT_VERSION) $^
> +	$(ASCIIDOC) -b $(ASCIIDOC_DOCBOOK) -d manpage $(ASCIIDOC_CONF) \
> +		-agit_version=$(GIT_VERSION) $(ASCIIDOC_EXTRA) $^
>  
>  $(GIT_SUBTREE_HTML): $(GIT_SUBTREE_TXT)
> -	$(ASCIIDOC) -b xhtml11 -d manpage -f $(ASCIIDOC_CONF) \
> -		-agit_version=$(GIT_VERSION) $^
> +	$(ASCIIDOC) -b $(ASCIIDOC_HTML) -d manpage $(ASCIIDOC_CONF) \
> +		-agit_version=$(GIT_VERSION) $(ASCIIDOC_EXTRA) $^
>  
>  $(GIT_SUBTREE_TEST): $(GIT_SUBTREE)
>  	cp $< $@