Skip to content
This repository was archived by the owner on Nov 9, 2017. It is now read-only.

Commit fe77b41

Browse files
peffgitster
authored andcommitted
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 <[email protected]> Signed-off-by: Matthieu Moy <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 04ab6ae commit fe77b41

File tree

5 files changed

+8
-6
lines changed

5 files changed

+8
-6
lines changed

Documentation/Makefile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,7 @@ technical/api-index.txt: technical/api-index-skel.txt \
270270
technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
271271
$(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh
272272

273+
technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
273274
$(patsubst %,%.html,$(API_DOCS) technical/api-index): %.html : %.txt
274275
$(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -f asciidoc.conf \
275276
$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) $*.txt
@@ -323,6 +324,7 @@ $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
323324

324325
WEBDOC_DEST = /pub/software/scm/git/docs
325326

327+
howto/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
326328
$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt
327329
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
328330
sed -e '1,/^$$/d' $< | $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b xhtml11 - >$@+ && \

Documentation/asciidoc.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,5 +91,5 @@ endif::doctype-manpage[]
9191

9292
ifdef::backend-xhtml11[]
9393
[linkgit-inlinemacro]
94-
<a href="{target}.html">{target}{0?({0})}</a>
94+
<a href="{git-relative-html-prefix}{target}.html">{target}{0?({0})}</a>
9595
endif::backend-xhtml11[]

Documentation/technical/api-config.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ config API
22
==========
33

44
The config API gives callers a way to access git configuration files
5-
(and files which have the same syntax). See linkgit:../git-config[1] for a
5+
(and files which have the same syntax). See linkgit:git-config[1] for a
66
discussion of the config file syntax.
77

88
General Usage

Documentation/technical/api-credentials.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ longer than a single git process; e.g., credentials may be stored
180180
in-memory for a few minutes, or indefinitely on disk).
181181

182182
Each helper is specified by a single string in the configuration
183-
variable `credential.helper` (and others, see linkgit:../git-config[1]).
183+
variable `credential.helper` (and others, see linkgit:git-config[1]).
184184
The string is transformed by git into a command to be executed using
185185
these rules:
186186

@@ -293,6 +293,6 @@ helpers will just ignore the new requests).
293293
See also
294294
--------
295295

296-
linkgit:../gitcredentials[7]
296+
linkgit:gitcredentials[7]
297297

298-
linkgit:../git-config[5] (See configuration variables `credential.*`)
298+
linkgit:git-config[5] (See configuration variables `credential.*`)

Documentation/technical/api-merge.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ the operation of a low-level (single file) merge. Some options:
3636
ancestors in a recursive merge.
3737
If a helper program is specified by the
3838
`[merge "<driver>"] recursive` configuration, it will
39-
be used (see linkgit:../gitattributes[5]).
39+
be used (see linkgit:gitattributes[5]).
4040

4141
`variant`::
4242
Resolve local conflicts automatically in favor

0 commit comments

Comments
 (0)