Subject: Re: [PATCH] Documentation: Make AsciiDoc links always point to HTML files

From: Junio C Hamano <[email-masked]>
Date: Fri, 06 Sep 2013 14:43:34 -0700

Sebastian Schuberth <[email-masked]> writes:

> AsciiDoc's "link" is supposed to create hyperlinks for HTML output, so
> prefer a "link" to point to an HTML file instead of a text file if an HTML
> version of the file is being generated. For RelNotes, keep pointing to
> text files as no equivalent HTML files are generated.
>
> If appropriate, also update the link description to not contain the linked
> file's extension.
>
> Signed-off-by: Sebastian Schuberth <[email-masked]>
> ---

Makes sense; we should have done this back when we applied 5e00439f
(Documentation: build html for all files in technical and howto,
2012-10-23).

>  Documentation/everyday.txt                | 2 +-
>  Documentation/git-credential.txt          | 2 +-
>  Documentation/git-rebase.txt              | 4 ++--
>  Documentation/git-revert.txt              | 2 +-
>  Documentation/gitcvs-migration.txt        | 2 +-
>  Documentation/technical/http-protocol.txt | 4 ++--
>  Documentation/user-manual.txt             | 4 ++--
>  7 files changed, 10 insertions(+), 10 deletions(-)
>
> diff --git a/Documentation/everyday.txt b/Documentation/everyday.txt
> index e1fba85..2a18c1f 100644
> --- a/Documentation/everyday.txt
> +++ b/Documentation/everyday.txt
> @@ -304,7 +304,7 @@ and maintain access to the repository by developers.
>    * linkgit:git-shell[1] can be used as a 'restricted login shell'
>      for shared central repository users.
>  
> -link:howto/update-hook-example.txt[update hook howto] has a good
> +link:howto/update-hook-example.html[update hook howto] has a good
>  example of managing a shared central repository.
>  
>  
> diff --git a/Documentation/git-credential.txt b/Documentation/git-credential.txt
> index 7da0f13..b211440 100644
> --- a/Documentation/git-credential.txt
> +++ b/Documentation/git-credential.txt
> @@ -20,7 +20,7 @@ usernames and passwords. The git-credential command exposes this
>  interface to scripts which may want to retrieve, store, or prompt for
>  credentials in the same manner as Git. The design of this scriptable
>  interface models the internal C API; see
> -link:technical/api-credentials.txt[the Git credential API] for more
> +link:technical/api-credentials.html[the Git credential API] for more
>  background on the concepts.
>  
>  git-credential takes an "action" option on the command-line (one of
> diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
> index 6b2e1c8..94e07fd 100644
> --- a/Documentation/git-rebase.txt
> +++ b/Documentation/git-rebase.txt
> @@ -322,7 +322,7 @@ You may find this (or --no-ff with an interactive rebase) helpful after
>  reverting a topic branch merge, as this option recreates the topic branch with
>  fresh commits so it can be remerged successfully without needing to "revert
>  the reversion" (see the
> -link:howto/revert-a-faulty-merge.txt[revert-a-faulty-merge How-To] for details).
> +link:howto/revert-a-faulty-merge.html[revert-a-faulty-merge How-To] for details).
>  
>  --ignore-whitespace::
>  --whitespace=<option>::
> @@ -416,7 +416,7 @@ Without --interactive, this is a synonym for --force-rebase.
>  You may find this helpful after reverting a topic branch merge, as this option
>  recreates the topic branch with fresh commits so it can be remerged
>  successfully without needing to "revert the reversion" (see the
> -link:howto/revert-a-faulty-merge.txt[revert-a-faulty-merge How-To] for details).
> +link:howto/revert-a-faulty-merge.html[revert-a-faulty-merge How-To] for details).
>  
>  include::merge-strategies.txt[]
>  
> diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt
> index f79c9d8..2de67a5 100644
> --- a/Documentation/git-revert.txt
> +++ b/Documentation/git-revert.txt
> @@ -59,7 +59,7 @@ brought in by the merge.  As a result, later merges will only bring in tree
>  changes introduced by commits that are not ancestors of the previously
>  reverted merge.  This may or may not be what you want.
>  +
> -See the link:howto/revert-a-faulty-merge.txt[revert-a-faulty-merge How-To] for
> +See the link:howto/revert-a-faulty-merge.html[revert-a-faulty-merge How-To] for
>  more details.
>  
>  --no-edit::
> diff --git a/Documentation/gitcvs-migration.txt b/Documentation/gitcvs-migration.txt
> index 5ab5b07..5ea94cb 100644
> --- a/Documentation/gitcvs-migration.txt
> +++ b/Documentation/gitcvs-migration.txt
> @@ -157,7 +157,7 @@ points.  You can use these, for example, to send all commits to the shared
>  repository to a mailing list.  See linkgit:githooks[5].
>  
>  You can enforce finer grained permissions using update hooks.  See
> -link:howto/update-hook-example.txt[Controlling access to branches using
> +link:howto/update-hook-example.html[Controlling access to branches using
>  update hooks].
>  
>  Providing CVS Access to a Git Repository
> diff --git a/Documentation/technical/http-protocol.txt b/Documentation/technical/http-protocol.txt
> index a1173ee..caf941a 100644
> --- a/Documentation/technical/http-protocol.txt
> +++ b/Documentation/technical/http-protocol.txt
> @@ -499,5 +499,5 @@ References
>  
>  link:http://www.ietf.org/rfc/rfc1738.txt[RFC 1738: Uniform Resource Locators (URL)]
>  link:http://www.ietf.org/rfc/rfc2616.txt[RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1]
> -link:technical/pack-protocol.txt
> -link:technical/protocol-capabilities.txt
> +link:technical/pack-protocol.html
> +link:technical/protocol-capabilities.html
> diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
> index fe723e4..ed01c98 100644
> --- a/Documentation/user-manual.txt
> +++ b/Documentation/user-manual.txt
> @@ -1977,7 +1977,7 @@ $ git clone http://yourserver.com/~you/proj.git
>  -------------------------------------------------
>  
>  (See also
> -link:howto/setup-git-server-over-http.txt[setup-git-server-over-http]
> +link:howto/setup-git-server-over-http.html[setup-git-server-over-http]
>  for a slightly more sophisticated setup using WebDAV which also
>  allows pushing over HTTP.)
>  
> @@ -3191,7 +3191,7 @@ those "loose" objects.
>  You can save space and make Git faster by moving these loose objects in
>  to a "pack file", which stores a group of objects in an efficient
>  compressed format; the details of how pack files are formatted can be
> -found in link:technical/pack-format.txt[technical/pack-format.txt].
> +found in link:technical/pack-format.html[pack format].
>  
>  To put the loose objects into a pack, just run git repack: