# [Patch 0/1] Makefile extensions for topic ta/doc-cleanup in pu 8 messages from 2012-10-23 to 2012-11-12. Participants: Thomas Ackermann, Jeff King, Junio C Hamano. Thread: https://gitlist.dev/t/31919 ## Thomas Ackermann, 2012-10-23 17:55 Subject: [Patch 0/1] Makefile extensions for topic ta/doc-cleanup in pu Message-ID: <139737172.296334.1351014913982.JavaMail.ngmail@webmail16.arcor-online.net> URL: https://gitlist.dev/e/139737172.296334.1351014913982.JavaMail.ngmail%40webmail16.arcor-online.net ``` This patch adds rules to the "html" taget in Documentation/Makefile to create html also for the new asciidoc files in Documentation/technical and Documentation/howto which were added in this topic. --- Thomas ``` ## Thomas Ackermann, 2012-10-23 17:58 Subject: [Patch 1/1] Wire html for all files in ./technical and ./howto in Makefile Message-ID: <1531209463.296427.1351015084181.JavaMail.ngmail@webmail16.arcor-online.net> URL: https://gitlist.dev/e/1531209463.296427.1351015084181.JavaMail.ngmail%40webmail16.arcor-online.net In-Reply-To: <139737172.296334.1351014913982.JavaMail.ngmail@webmail16.arcor-online.net> ``` - target "html" creates html for all files in Documentation/howto and Documentation/technical Signed-off-by: Thomas Ackermann --- Documentation/Makefile | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/Documentation/Makefile b/Documentation/Makefile index 267dfe1..c4e5594 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -24,8 +24,30 @@ SP_ARTICLES = user-manual SP_ARTICLES += howto/revert-branch-rebase SP_ARTICLES += howto/using-merge-subtree SP_ARTICLES += howto/using-signed-tag-in-pull-request +SP_ARTICLES += howto/use-git-daemon +SP_ARTICLES += howto/update-hook-example +SP_ARTICLES += howto/setup-git-server-over-http +SP_ARTICLES += howto/separating-topic-branches +SP_ARTICLES += howto/revert-a-faulty-merge +SP_ARTICLES += howto/recover-corrupted-blob-object +SP_ARTICLES += howto/rebuild-from-update-hook +SP_ARTICLES += howto/rebuild-from-update-hook +SP_ARTICLES += howto/rebase-from-internal-branch +SP_ARTICLES += howto/maintain-git API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt))) SP_ARTICLES += $(API_DOCS) + +TECH_DOCS = technical/index-format +TECH_DOCS += technical/pack-format +TECH_DOCS += technical/pack-heuristics +TECH_DOCS += technical/pack-protocol +TECH_DOCS += technical/protocol-capabilities +TECH_DOCS += technical/protocol-common +TECH_DOCS += technical/racy-git +TECH_DOCS += technical/send-pack-pipeline +TECH_DOCS += technical/shallow +TECH_DOCS += technical/trivial-merge +SP_ARTICLES += $(TECH_DOCS) SP_ARTICLES += technical/api-index DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES)) @@ -231,7 +253,7 @@ clean: $(RM) *.texi *.texi+ *.texi++ git.info gitman.info $(RM) *.pdf $(RM) howto-index.txt howto/*.html doc.dep - $(RM) technical/api-*.html technical/api-index.txt + $(RM) technical/*.html technical/api-index.txt $(RM) $(cmds_txt) *.made $(RM) manpage-base-url.xsl @@ -264,7 +286,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): %.html : %.txt +$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \ $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt -- 1.7.11.msysgit.1 --- Thomas ``` ## Jeff King, 2012-10-25 09:42 Subject: Re: [Patch 1/1] Wire html for all files in ./technical and ./howto in Makefile Message-ID: <20121025094205.GI8390@sigill.intra.peff.net> URL: https://gitlist.dev/e/20121025094205.GI8390%40sigill.intra.peff.net In-Reply-To: <1531209463.296427.1351015084181.JavaMail.ngmail@webmail16.arcor-online.net> ``` On Tue, Oct 23, 2012 at 07:58:04PM +0200, Thomas Ackermann wrote: > - target "html" creates html for all files in Documentation/howto and > Documentation/technical Thanks. > +TECH_DOCS = technical/index-format > +TECH_DOCS += technical/pack-format > +TECH_DOCS += technical/pack-heuristics > +TECH_DOCS += technical/pack-protocol > +TECH_DOCS += technical/protocol-capabilities > +TECH_DOCS += technical/protocol-common > +TECH_DOCS += technical/racy-git > +TECH_DOCS += technical/send-pack-pipeline > +TECH_DOCS += technical/shallow > +TECH_DOCS += technical/trivial-merge > +SP_ARTICLES += $(TECH_DOCS) I wonder if these could even be part of the generated api-index.html (that is, if somebody is reading about the API, they just as well may want to see these format documents). But I do not overly care much, as I (and I suspect most other developers) just read the technical documentation in its original txt format. If somebody cares, we can easily build it on top. -Peff ``` ## Thomas Ackermann, 2012-10-29 18:33 Subject: Aw: Re: [Patch 1/1] Wire html for all files in ./technical and ./howto in Makefile Message-ID: <884264929.71955.1351535627736.JavaMail.ngmail@webmail09.arcor-online.net> URL: https://gitlist.dev/e/884264929.71955.1351535627736.JavaMail.ngmail%40webmail09.arcor-online.net In-Reply-To: <20121025094205.GI8390@sigill.intra.peff.net> ``` This patch addresses Junios comment in WC: "Misapplication of a patch fixed; the ones near the tip needs to update the links to point at the html files, though." See older mail in this thread: --- Thomas Ackermann writes: > BTW1: As only the changes in the doc files where cherry-picked, currently on pu howto-index.sh > will create invalid links in howto-index.html because it scans all .txt-files in ./howto for > 'Content-type: text/asciidoc' and if found, creates a reference to a html file. But these are not created > for the new asciidoc files. So the changes in Documentation/Makefile which create html for the new > files should be merged also. Ah, I didn't notice that. That means that for the patch [6/8], which adds content-type to the text files, to be complete, it needs to update Makefile to produce html files from them. Thanks. --- So IMHO no open issues with this patch. ----- Original Nachricht ---- Von: Jeff King An: Thomas Ackermann Datum: 25.10.2012 11:42 Betreff: Re: [Patch 1/1] Wire html for all files in ./technical and ./howto in Makefile > On Tue, Oct 23, 2012 at 07:58:04PM +0200, Thomas Ackermann wrote: > > > - target "html" creates html for all files in Documentation/howto and > > Documentation/technical > > Thanks. > --- Thomas ``` ## Jeff King, 2012-10-29 21:57 Subject: Re: Re: [Patch 1/1] Wire html for all files in ./technical and ./howto in Makefile Message-ID: <20121029215739.GG20513@sigill.intra.peff.net> URL: https://gitlist.dev/e/20121029215739.GG20513%40sigill.intra.peff.net In-Reply-To: <884264929.71955.1351535627736.JavaMail.ngmail@webmail09.arcor-online.net> ``` On Mon, Oct 29, 2012 at 07:33:47PM +0100, Thomas Ackermann wrote: > This patch addresses Junios comment in WC: > "Misapplication of a patch fixed; the ones near the tip needs to > update the links to point at the html files, though." > > See older mail in this thread: > [...] > That means that for the patch [6/8], which adds content-type to the > text files, to be complete, it needs to update Makefile to produce > html files from them. > [...] > So IMHO no open issues with this patch. OK, that explains the situation. Thanks, I'll merge it to master in the next iteration. -Peff ``` ## Junio C Hamano, 2012-11-12 17:45 Subject: Re: [Patch 1/1] Wire html for all files in ./technical and ./howto in Makefile Message-ID: <7vpq3iiukk.fsf@alter.siamese.dyndns.org> URL: https://gitlist.dev/e/7vpq3iiukk.fsf%40alter.siamese.dyndns.org In-Reply-To: <20121029215739.GG20513@sigill.intra.peff.net> ``` Jeff King writes: > On Mon, Oct 29, 2012 at 07:33:47PM +0100, Thomas Ackermann wrote: > >> This patch addresses Junios comment in WC: >> "Misapplication of a patch fixed; the ones near the tip needs to >> update the links to point at the html files, though." >> >> See older mail in this thread: >> [...] >> That means that for the patch [6/8], which adds content-type to the >> text files, to be complete, it needs to update Makefile to produce >> html files from them. >> [...] >> So IMHO no open issues with this patch. > > OK, that explains the situation. Thanks, I'll merge it to master in the > next iteration. What happened to this topic? ``` ## Jeff King, 2012-11-12 19:19 Subject: Re: [Patch 1/1] Wire html for all files in ./technical and ./howto in Makefile Message-ID: <20121112191953.GA4623@sigill.intra.peff.net> URL: https://gitlist.dev/e/20121112191953.GA4623%40sigill.intra.peff.net In-Reply-To: <7vpq3iiukk.fsf@alter.siamese.dyndns.org> ``` On Mon, Nov 12, 2012 at 09:45:31AM -0800, Junio C Hamano wrote: > Jeff King writes: > > > On Mon, Oct 29, 2012 at 07:33:47PM +0100, Thomas Ackermann wrote: > > > >> This patch addresses Junios comment in WC: > >> "Misapplication of a patch fixed; the ones near the tip needs to > >> update the links to point at the html files, though." > >> > >> See older mail in this thread: > >> [...] > >> That means that for the patch [6/8], which adds content-type to the > >> text files, to be complete, it needs to update Makefile to produce > >> html files from them. > >> [...] > >> So IMHO no open issues with this patch. > > > > OK, that explains the situation. Thanks, I'll merge it to master in the > > next iteration. > > What happened to this topic? I mistyped in the above response; it should have been "next" not "master". But then I forgot to merge it to next in the last iteration; it is ta/doc-cleanup in pu, and is marked in "What's Cooking" to be merged to next. -Peff ``` ## Junio C Hamano, 2012-11-12 20:13 Subject: Re: [Patch 1/1] Wire html for all files in ./technical and ./howto in Makefile Message-ID: <7vvcdah95v.fsf@alter.siamese.dyndns.org> URL: https://gitlist.dev/e/7vvcdah95v.fsf%40alter.siamese.dyndns.org In-Reply-To: <20121112191953.GA4623@sigill.intra.peff.net> ``` Jeff King writes: > On Mon, Nov 12, 2012 at 09:45:31AM -0800, Junio C Hamano wrote: > >> Jeff King writes: >> >> > On Mon, Oct 29, 2012 at 07:33:47PM +0100, Thomas Ackermann wrote: >> > >> >> This patch addresses Junios comment in WC: >> >> "Misapplication of a patch fixed; the ones near the tip needs to >> >> update the links to point at the html files, though." >> >> >> >> See older mail in this thread: >> >> [...] >> >> That means that for the patch [6/8], which adds content-type to the >> >> text files, to be complete, it needs to update Makefile to produce >> >> html files from them. >> >> [...] >> >> So IMHO no open issues with this patch. >> > >> > OK, that explains the situation. Thanks, I'll merge it to master in the >> > next iteration. >> >> What happened to this topic? > > I mistyped in the above response; it should have been "next" not > "master". Ah, ok, I was just wondering why I didn't see it in your 'master'. Thanks. > But then I forgot to merge it to next in the last iteration; it is > ta/doc-cleanup in pu, and is marked in "What's Cooking" to be merged to > next. > > -Peff ```