summaryrefslogtreecommitdiff
path: root/Documentation/technical/api-config.txt
diff options
context:
space:
mode:
authorJeff King <peff@peff.net>2012-06-07 21:03:23 (GMT)
committerJunio C Hamano <gitster@pobox.com>2012-06-08 15:31:52 (GMT)
commitfe77b416c774a469a585c4b58fcae5e7a5f3545d (patch)
tree061ebc63f37f82f7852733fc311333dc7c2c789f /Documentation/technical/api-config.txt
parent04ab6ae7765700375e9442347430fc3a6de40f81 (diff)
downloadgit-fe77b416c774a469a585c4b58fcae5e7a5f3545d.zip
git-fe77b416c774a469a585c4b58fcae5e7a5f3545d.tar.gz
git-fe77b416c774a469a585c4b58fcae5e7a5f3545d.tar.bz2
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> Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/technical/api-config.txt')
-rw-r--r--Documentation/technical/api-config.txt2
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/technical/api-config.txt b/Documentation/technical/api-config.txt
index bd4d8b8..edf8dfb 100644
--- a/Documentation/technical/api-config.txt
+++ b/Documentation/technical/api-config.txt
@@ -2,7 +2,7 @@ config API
==========
The config API gives callers a way to access git configuration files
-(and files which have the same syntax). See linkgit:../git-config[1] for a
+(and files which have the same syntax). See linkgit:git-config[1] for a
discussion of the config file syntax.
General Usage