Re: [PATCH 3/3] api-credentials.txt: add "see also" section

[Junio C Hamano <gitster@pobox.com>]

Jeff King <peff@peff.net> writes:

> On Tue, Jun 05, 2012 at 02:59:55AM -0400, Jeff King wrote:
>
>> I wonder if we could even make asciidoc work to convert
>> linkgit:git-config[1] into the right path (i.e., to include the ".."
>> automatically) when we are in the subdir.
>> 
>> I don't really have a sense how powerful asciidoc macros are, but this
>> seems like an obvious case that they should handle.
>
> Here is a simple fix. The Makefile bits are more hacky than I would
> like. It would be really nice if the asciidoc macro could convert "we
> are working on X/Y/Z.html" into "we need ../../ to get to the relative
> base", but I don't think it is that flexible.
>
> We could also replace asciidoc with a wrapper script that does the
> conversion and sets the appropriate attribute. I don't know if it is
> worth the trouble. It's not like we add documentation subdirectories
> very often.

Sorry, but I am not sure what problem is this trying to solve.  An
API documentation page should only refer to command documentaion
pages, and never another API documentation page that is at the same
level?

> -- >8 --
> Subject: docs: fix cross-directory linkgit references
>
> Most of our documentation is in a single directory, so using
> linkgit:git-config[1] just generates a relative link in the
> same directory. However, this is not the case with the API
> documentation in technical/*, which need to refer to
> git-config from the parent directory.
>
> We can fix this by passing a special prefix attribute when building
> in a subdirectory, and respecting that prefix in our linkgit
> definitions.
>
> We only have to modify the html linkgit definition.  For
> manpages, we can ignore this for two reasons:
>
>   1. we do not generate actual links to the file in
>      manpages, but instead just give the name and section of
>      the linked manpage
>
>   2. we do not currently build manpages for subdirectories,
>      only html
>
> Signed-off-by: Jeff King <peff@peff.net>
> ---
>  Documentation/Makefile      | 2 ++
>  Documentation/asciidoc.conf | 2 +-
>  2 files changed, 3 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/Makefile b/Documentation/Makefile
> index 14286cb..b3693c8 100644
> --- a/Documentation/Makefile
> +++ b/Documentation/Makefile
> @@ -280,6 +280,7 @@ technical/api-index.txt: technical/api-index-skel.txt \
>  	technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
>  	$(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
>  	$(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
>  		$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt
> @@ -333,6 +334,7 @@ $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
>  
>  WEBDOC_DEST = /pub/software/scm/git/docs
>  
> +howto/%.html: ASCIIDOC_EXTRA += git-relative-html-prefix=../
>  $(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
>  	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
>  	sed -e '1,/^$$/d' $< | $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 - >$@+ && \
> diff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf
> index aea8627..6d06271 100644
> --- a/Documentation/asciidoc.conf
> +++ b/Documentation/asciidoc.conf
> @@ -91,5 +91,5 @@ endif::doctype-manpage[]
>  
>  ifdef::backend-xhtml11[]
>  [linkgit-inlinemacro]
> -<a href="{target}.html">{target}{0?({0})}</a>
> +<a href="{git-relative-html-prefix}{target}.html">{target}{0?({0})}</a>
>  endif::backend-xhtml11[]