# [PATCH] Documentation: fix man page dependency on asciidoc.conf 6 messages from 2013-01-05 to 2013-01-06. Participants: John Keeping, Jonathan Nieder, Junio C Hamano. Thread: https://gitlist.dev/t/32533 ## John Keeping, 2013-01-05 16:00 Subject: [PATCH] Documentation: fix man page dependency on asciidoc.conf Message-ID: <20130105160017.GD6440@serenity.lan> URL: https://gitlist.dev/e/20130105160017.GD6440%40serenity.lan ``` When building manual pages, the source text is transformed to XML with AsciiDoc before the man pages are generated from the XML with xmlto. Fix the dependency in the Makefile so that the XML files are rebuilt when asciidoc.conf changes and not just the manual pages from unchanged XML. Signed-off-by: John Keeping --- Documentation/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Makefile b/Documentation/Makefile index e53d333..71d2b4a 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -178,7 +178,7 @@ all: html man html: $(DOC_HTML) -$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf +$(DOC_HTML) $(MAN_XML): asciidoc.conf man: man1 man5 man7 man1: $(DOC_MAN1) -- 1.8.0.2 ``` ## Jonathan Nieder, 2013-01-05 23:28 Subject: Re: [PATCH] Documentation: fix man page dependency on asciidoc.conf Message-ID: <20130105232800.GF3247@elie.Belkin> URL: https://gitlist.dev/e/20130105232800.GF3247%40elie.Belkin In-Reply-To: <20130105160017.GD6440@serenity.lan> ``` John Keeping wrote: > When building manual pages, the source text is transformed to XML with > AsciiDoc before the man pages are generated from the XML with xmlto. > > Fix the dependency in the Makefile so that the XML files are rebuilt > when asciidoc.conf changes and not just the manual pages from unchanged > XML. Good catch, thanks. Would something like the following make sense, to make it more obvious how the dependency needs to be adjusted if we change the $(ASCIIDOC) command line for some reason? diff --git i/Documentation/Makefile w/Documentation/Makefile index e53d333e..971977b8 100644 --- i/Documentation/Makefile +++ w/Documentation/Makefile @@ -178,8 +178,6 @@ all: html man html: $(DOC_HTML) -$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf - man: man1 man5 man7 man1: $(DOC_MAN1) man5: $(DOC_MAN5) @@ -257,7 +255,7 @@ clean: $(RM) $(cmds_txt) *.made $(RM) manpage-base-url.xsl -$(MAN_HTML): %.html : %.txt +$(MAN_HTML): %.html : %.txt asciidoc.conf $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \ $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \ $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \ @@ -270,7 +268,7 @@ manpage-base-url.xsl: manpage-base-url.xsl.in $(QUIET_XMLTO)$(RM) $@ && \ $(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $< -%.xml : %.txt +%.xml : %.txt asciidoc.conf $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \ $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \ $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \ @@ -286,7 +284,7 @@ technical/api-index.txt: technical/api-index-skel.txt \ $(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../ -$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt +$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt asciidoc.conf $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \ $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt diff --git i/t/test-terminal.perl w/t/test-terminal.perl index 10172aee..1fb373f2 100755 --- i/t/test-terminal.perl +++ w/t/test-terminal.perl @@ -31,7 +31,7 @@ sub finish_child { } elsif ($? & 127) { my $code = $? & 127; warn "died of signal $code"; - return $code - 128; + return $code + 128; } else { return $? >> 8; } ``` ## Junio C Hamano, 2013-01-06 06:51 Subject: Re: [PATCH] Documentation: fix man page dependency on asciidoc.conf Message-ID: <7vbod2pzxd.fsf@alter.siamese.dyndns.org> URL: https://gitlist.dev/e/7vbod2pzxd.fsf%40alter.siamese.dyndns.org In-Reply-To: <20130105232800.GF3247@elie.Belkin> ``` Jonathan Nieder writes: > John Keeping wrote: > >> When building manual pages, the source text is transformed to XML with >> AsciiDoc before the man pages are generated from the XML with xmlto. >> >> Fix the dependency in the Makefile so that the XML files are rebuilt >> when asciidoc.conf changes and not just the manual pages from unchanged >> XML. > > Good catch, thanks. > > Would something like the following make sense, to make it more obvious > how the dependency needs to be adjusted if we change the $(ASCIIDOC) > command line for some reason? I think such a more explicit approach is easier to understand, than a separate "By the way, I do not define any rule to build these targets using asciidoc.conf, but I know they depend on it" rule. Care to do a real patch? Thanks. > diff --git i/Documentation/Makefile w/Documentation/Makefile > index e53d333e..971977b8 100644 > --- i/Documentation/Makefile > +++ w/Documentation/Makefile > @@ -178,8 +178,6 @@ all: html man > > html: $(DOC_HTML) > > -$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf > - > man: man1 man5 man7 > man1: $(DOC_MAN1) > man5: $(DOC_MAN5) > @@ -257,7 +255,7 @@ clean: > $(RM) $(cmds_txt) *.made > $(RM) manpage-base-url.xsl > > -$(MAN_HTML): %.html : %.txt > +$(MAN_HTML): %.html : %.txt asciidoc.conf > $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \ > $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \ > $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \ > @@ -270,7 +268,7 @@ manpage-base-url.xsl: manpage-base-url.xsl.in > $(QUIET_XMLTO)$(RM) $@ && \ > $(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $< > > -%.xml : %.txt > +%.xml : %.txt asciidoc.conf > $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \ > $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \ > $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \ > @@ -286,7 +284,7 @@ technical/api-index.txt: technical/api-index-skel.txt \ > $(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh > > technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../ > -$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt > +$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt asciidoc.conf > $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \ > $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt > > diff --git i/t/test-terminal.perl w/t/test-terminal.perl > index 10172aee..1fb373f2 100755 > --- i/t/test-terminal.perl > +++ w/t/test-terminal.perl > @@ -31,7 +31,7 @@ sub finish_child { > } elsif ($? & 127) { > my $code = $? & 127; > warn "died of signal $code"; > - return $code - 128; > + return $code + 128; > } else { > return $? >> 8; > } ``` ## Jonathan Nieder, 2013-01-06 12:01 Subject: [PATCH] docs: manpage XML depends on asciidoc.conf Message-ID: <20130106120153.GB22081@elie.Belkin> URL: https://gitlist.dev/e/20130106120153.GB22081%40elie.Belkin In-Reply-To: <7vbod2pzxd.fsf@alter.siamese.dyndns.org> ``` When building manual pages, the source text is transformed to XML with AsciiDoc before the man pages are generated from the XML with xmlto. Fix the dependencies in the Makefile so that the XML files are rebuilt when asciidoc.conf changes and not just the manual pages from unchanged XML, and move the dependencies from a recipeless rule to the rules with commands that use asciidoc.conf to make the dependencies easier to understand and maintain. Reported-by: John Keeping Signed-off-by: Jonathan Nieder --- Junio C Hamano wrote: > Care to do a real patch? Here you go. Documentation/Makefile | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/Documentation/Makefile b/Documentation/Makefile index e53d333e..971977b8 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -178,8 +178,6 @@ all: html man html: $(DOC_HTML) -$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf - man: man1 man5 man7 man1: $(DOC_MAN1) man5: $(DOC_MAN5) @@ -257,7 +255,7 @@ clean: $(RM) $(cmds_txt) *.made $(RM) manpage-base-url.xsl -$(MAN_HTML): %.html : %.txt +$(MAN_HTML): %.html : %.txt asciidoc.conf $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \ $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \ $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \ @@ -270,7 +268,7 @@ manpage-base-url.xsl: manpage-base-url.xsl.in $(QUIET_XMLTO)$(RM) $@ && \ $(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $< -%.xml : %.txt +%.xml : %.txt asciidoc.conf $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \ $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \ $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \ @@ -286,7 +284,7 @@ technical/api-index.txt: technical/api-index-skel.txt \ $(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../ -$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt +$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt asciidoc.conf $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \ $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt -- 1.8.1 ``` ## John Keeping, 2013-01-06 12:33 Subject: Re: [PATCH] docs: manpage XML depends on asciidoc.conf Message-ID: <20130106123326.GF6440@serenity.lan> URL: https://gitlist.dev/e/20130106123326.GF6440%40serenity.lan In-Reply-To: <20130106120153.GB22081@elie.Belkin> ``` On Sun, Jan 06, 2013 at 04:01:53AM -0800, Jonathan Nieder wrote: > When building manual pages, the source text is transformed to XML with > AsciiDoc before the man pages are generated from the XML with xmlto. > > Fix the dependencies in the Makefile so that the XML files are rebuilt > when asciidoc.conf changes and not just the manual pages from > unchanged XML, and move the dependencies from a recipeless rule to the > rules with commands that use asciidoc.conf to make the dependencies > easier to understand and maintain. > > Reported-by: John Keeping > Signed-off-by: Jonathan Nieder > --- This fixes the problem I wanted to fix (as well as being clearer for the future), so FWIW: Tested-by: John Keeping ``` ## Junio C Hamano, 2013-01-06 23:19 Subject: Re: [PATCH] docs: manpage XML depends on asciidoc.conf Message-ID: <7vtxqtlx0w.fsf@alter.siamese.dyndns.org> URL: https://gitlist.dev/e/7vtxqtlx0w.fsf%40alter.siamese.dyndns.org In-Reply-To: <20130106123326.GF6440@serenity.lan> ``` Thanks. ```