threads / patch / 31919

patchMakefile extensions for topic ta/doc-cleanup in pu

Subject: [Patch 0/1] Makefile extensions for topic ta/doc-cleanup in pu

## tl;dr

8 messages between Oct 23, 2012 and Nov 12, 2012. Diffs are folded; open one to read it.

replies: 7people: 3as markdown or json

Thomas Ackermann· Oct 23, 2012, 17:55 UTC · lore

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· Oct 23, 2012, 17:58 UTC · re: Thomas Ackermann · lore

[Patch 1/1] Wire html for all files in ./technical and ./howto in Makefile

- target "html" creates html for all files in Documentation/howto and Documentation/technical

Signed-off-by: Thomas Ackermann <th.acker66@arcor.de>
---
 Documentation/Makefile | 26 ++++++++++++++++++++++++--
 1 file changed, 24 insertions(+), 2 deletions(-)

Show changes to Documentation/Makefile +24 −2

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· Oct 25, 2012, 09:42 UTC · re: Thomas Ackermann · lore

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.

Show 11 quoted lines

> +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· Oct 29, 2012, 18:33 UTC · re: Jeff King · lore

Aw: Re: [Patch 1/1] Wire html for all files in ./technical and ./howto in Makefile

 
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 <th.acker66@arcor.de> writes:

Show 5 quoted lines

> 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 <peff@peff.net>
An:      Thomas Ackermann <th.acker66@arcor.de>
Datum:   25.10.2012 11:42
Betreff: Re: [Patch 1/1] Wire html for all files in ./technical and ./howto
 in Makefile

Show 7 quoted lines

> 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· Oct 29, 2012, 21:57 UTC · re: Thomas Ackermann · lore

Re: Re: [Patch 1/1] Wire html for all files in ./technical and ./howto in Makefile

On Mon, Oct 29, 2012 at 07:33:47PM +0100, Thomas Ackermann wrote:

Show 11 quoted lines

> 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· Nov 12, 2012, 17:45 UTC · re: Jeff King · lore

Re: [Patch 1/1] Wire html for all files in ./technical and ./howto in Makefile

Jeff King <peff@peff.net> writes:

Show 16 quoted lines

> 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· Nov 12, 2012, 19:19 UTC · re: Junio C Hamano · lore

Re: [Patch 1/1] Wire html for all files in ./technical and ./howto in Makefile

On Mon, Nov 12, 2012 at 09:45:31AM -0800, Junio C Hamano wrote:

Show 20 quoted lines

> Jeff King <peff@peff.net> 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· Nov 12, 2012, 20:13 UTC · re: Jeff King · lore

Re: [Patch 1/1] Wire html for all files in ./technical and ./howto in Makefile

Jeff King <peff@peff.net> writes:

Show 25 quoted lines

> On Mon, Nov 12, 2012 at 09:45:31AM -0800, Junio C Hamano wrote:
>
>> Jeff King <peff@peff.net> 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.

Show 5 quoted lines

> 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