diff options
| author | Roberto Tyley <roberto.tyley@gmail.com> | 2014-02-18 21:42:22 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2014-02-20 22:14:58 (GMT) |
| commit | 2df85669d16703714968572937ebb67a31241ca3 (patch) | |
| tree | 31e0852db93b0bed9f679fdb657e1a17078aa0fd /Documentation/gitweb.txt | |
| parent | 5f95c9f850b19b368c43ae399cc831b17a26a5ac (diff) | |
| download | git-2df85669d16703714968572937ebb67a31241ca3.zip git-2df85669d16703714968572937ebb67a31241ca3.tar.gz git-2df85669d16703714968572937ebb67a31241ca3.tar.bz2 | |
Documentation: fix documentation AsciiDoc links for external urls
Turns out that putting 'link:' before the 'http' is actually superfluous
in AsciiDoc, as there's already a predefined macro to handle it.
"http, https, [etc] URLs are rendered using predefined inline macros."
http://www.methods.co.nz/asciidoc/userguide.html#_urls
"Hypertext links to files on the local file system are specified
using the link inline macro."
http://www.methods.co.nz/asciidoc/userguide.html#_linking_to_local_documents
Despite being superfluous, the reference implementation of AsciiDoc
tolerates the extra 'link:' and silently removes it, giving a functioning
link in the generated HTML. However, AsciiDoctor (the Ruby implementation
of AsciiDoc used to render the http://git-scm.com/ site) does /not/ have
this behaviour, and so generates broken links, as can be seen here:
http://git-scm.com/docs/git-cvsimport (links to cvs2git & parsecvs)
http://git-scm.com/docs/git-filter-branch (link to The BFG)
It's worth noting that after this change, the html generated by 'make html'
in the git project is identical, and all links still work.
Signed-off-by: Roberto Tyley <roberto.tyley@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/gitweb.txt')
| -rw-r--r-- | Documentation/gitweb.txt | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt index cca14b8..cd9c895 100644 --- a/Documentation/gitweb.txt +++ b/Documentation/gitweb.txt @@ -84,7 +84,7 @@ separator (rules for Perl's "`split(" ", $line)`"). * Fields use modified URI encoding, defined in RFC 3986, section 2.1 (Percent-Encoding), or rather "Query string encoding" (see -link:http://en.wikipedia.org/wiki/Query_string#URL_encoding[]), the difference +http://en.wikipedia.org/wiki/Query_string#URL_encoding[]), the difference being that SP (" ") can be encoded as "{plus}" (and therefore "{plus}" has to be also percent-encoded). + |