undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
fe77b416c7
git-commit-vandalism/Documentation/technical
History
Jeff King fe77b416c7 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>
2012-06-08 08:31:52 -07:00
..
.gitignore Start preparing the API documents. 2007-12-14 22:29:38 -08:00
api-allocation-growing.txt Start preparing the API documents. 2007-12-14 22:29:38 -08:00
api-argv-array.txt argv-array: add a new "pushl" method 2012-04-18 16:16:38 -07:00
api-builtin.txt add gitignore entry to description about how to write a builtin 2011-08-03 11:44:23 -07:00
api-config.txt docs: fix cross-directory linkgit references 2012-06-08 08:31:52 -07:00
api-credentials.txt docs: fix cross-directory linkgit references 2012-06-08 08:31:52 -07:00
api-decorate.txt Start preparing the API documents. 2007-12-14 22:29:38 -08:00
api-diff.txt Documentation/technical/api-diff.txt: correct name of diff_unmerge() 2011-05-26 14:50:24 -07:00
api-directory-listing.txt Read .gitignore from index if it is skip-worktree 2009-08-23 17:13:33 -07:00
api-gitattributes.txt Rename git_checkattr() to git_check_attr() 2011-08-04 15:53:21 -07:00
api-grep.txt Start preparing the API documents. 2007-12-14 22:29:38 -08:00
api-hash.txt technical-docs: document hash API 2009-12-17 21:54:50 -08:00
api-history-graph.txt Documentation: undocument gc'd function graph_release() 2009-11-19 23:05:17 -08:00
api-in-core-index.txt Start preparing the API documents. 2007-12-14 22:29:38 -08:00
api-index-skel.txt Start preparing the API documents. 2007-12-14 22:29:38 -08:00
api-index.sh Start preparing the API documents. 2007-12-14 22:29:38 -08:00
api-lockfile.txt close_lock_file(): new function in the lockfile API 2008-01-16 15:35:03 -08:00
api-merge.txt docs: fix cross-directory linkgit references 2012-06-08 08:31:52 -07:00
api-object-access.txt Start preparing the API documents. 2007-12-14 22:29:38 -08:00
api-parse-options.txt docs: stop using asciidoc no-inline-literal 2012-04-26 13:19:06 -07:00
api-quote.txt Start preparing the API documents. 2007-12-14 22:29:38 -08:00
api-ref-iteration.txt add technical documentation about ref iteration 2011-08-22 15:01:14 -07:00
api-remote.txt technical/api-remote: Describe new struct remote member pushurl 2009-06-09 23:46:47 -07:00
api-revision-walking.txt Revision walking documentation: document most important functions 2008-05-31 14:32:56 -07:00
api-run-command.txt Enable threaded async procedures whenever pthreads is available 2010-03-10 14:26:54 -08:00
api-setup.txt Start preparing the API documents. 2007-12-14 22:29:38 -08:00
api-sha1-array.txt add sha1_array API docs 2011-09-14 11:44:05 -07:00
api-sigchain.txt Fix typos in the documentation 2011-01-04 11:23:42 -08:00
api-strbuf.txt strbuf: improve strbuf_get*line documentation 2012-02-23 13:52:11 -08:00
api-string-list.txt string-list: document that string_list_insert() inserts unique strings 2012-03-30 09:06:04 -07:00
api-tree-walking.txt unpack_trees: group error messages by type 2010-08-11 10:36:06 -07:00
api-xdiff-interface.txt Start preparing the API documents. 2007-12-14 22:29:38 -08:00
index-format.txt Documentation: clarify the invalidated tree entry format 2011-07-31 18:23:49 -07:00
pack-format.txt Add description of OFS_DELTA to the pack format description 2008-04-06 17:22:46 -07:00
pack-heuristics.txt Assorted typo fixes 2006-07-09 02:42:41 -07:00
pack-protocol.txt pack-protocol: fix first-want separator in the examples 2012-05-14 09:24:52 -07:00
protocol-capabilities.txt Documentation: Spelling fix in protocol-capabilities.txt 2010-07-09 17:36:28 -07:00
protocol-common.txt docs: stop using asciidoc no-inline-literal 2012-04-26 13:19:06 -07:00
racy-git.txt racy-git.txt: explain nsec problem in more detail 2009-10-09 14:56:32 -07:00
send-pack-pipeline.txt Update send-pack pipeline documentation. 2007-01-01 14:35:16 -08:00
shallow.txt Provide some technical documentation for shallow clones 2007-03-19 22:19:29 -07:00
trivial-merge.txt [PATCH] Finish documenting trivial merge rules 2005-09-24 22:05:55 -07:00