Documentation: fix documentation AsciiDoc links for external urls
commit2df85669d16703714968572937ebb67a31241ca3
authorRoberto Tyley <roberto.tyley@gmail.com>
Tue, 18 Feb 2014 21:42:22 +0000 (18 21:42 +0000)
committerJunio C Hamano <gitster@pobox.com>
Thu, 20 Feb 2014 22:14:58 +0000 (20 14:14 -0800)
tree31e0852db93b0bed9f679fdb657e1a17078aa0fd
parent5f95c9f850b19b368c43ae399cc831b17a26a5ac
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>
Documentation/git-cvsimport.txt
Documentation/git-filter-branch.txt
Documentation/gitcore-tutorial.txt
Documentation/gitcvs-migration.txt
Documentation/gitweb.txt
Documentation/technical/http-protocol.txt