Re: [PATCH 2/5] README.md: add hyperlinks on filenames

From: Junio C Hamano <gitster@pobox.com>
Date: Feb 23, 2016, 19:10 UTC
Message-ID: <xmqqio1f1bw7.fsf@gitster.mtv.corp.google.com>
In-Reply-To: <1456249229-30454-3-git-send-email-Matthieu.Moy@imag.fr>

Matthieu Moy <Matthieu.Moy@imag.fr> writes:

> Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
> ---
>  README.md | 19 +++++++++++++------
>  1 file changed, 13 insertions(+), 6 deletions(-)

Makes sense, provided if we want to do Markdown.

If I were pushing this topic (i.e. cater to those who browse at GitHub, not with "less" in the source tree), I'd have further made these links to the preformatted documentation at git-scm.com; I expected the later steps in this series to do that, but it seems you stopped short of it for some reason.

Show 47 quoted lines

> diff --git a/README.md b/README.md
> index 907eb3b..750fdda 100644
> --- a/README.md
> +++ b/README.md
> @@ -20,17 +20,17 @@ License version 2 (some parts of it are under different licenses,
>  compatible with the GPLv2). It was originally written by Linus
>  Torvalds with help of a group of hackers around the net.
>  
> -Please read the file INSTALL for installation instructions.
> +Please read the file [INSTALL][] for installation instructions.
>  
> -See Documentation/gittutorial.txt to get started, then see
> -Documentation/giteveryday.txt for a useful minimum set of commands, and
> -Documentation/git-commandname.txt for documentation of each command.
> +See [Documentation/gittutorial.txt][] to get started, then see
> +[Documentation/giteveryday.txt][] for a useful minimum set of commands, and
> +[Documentation/git-commandname.txt][] for documentation of each command.
>  If git has been correctly installed, then the tutorial can also be
>  read with "man gittutorial" or "git help tutorial", and the
>  documentation of each command with "man git-commandname" or "git help
>  commandname".
>  
> -CVS users may also want to read Documentation/gitcvs-migration.txt
> +CVS users may also want to read [Documentation/gitcvs-migration.txt][]
>  ("man gitcvs-migration" or "git help cvs-migration" if git is
>  installed).
>  
> @@ -40,7 +40,7 @@ including full documentation and Git related tools.
>  The user discussion and development of Git take place on the Git
>  mailing list -- everyone is welcome to post bug reports, feature
>  requests, comments and patches to git@vger.kernel.org (read
> -Documentation/SubmittingPatches for instructions on patch submission).
> +[Documentation/SubmittingPatches][] for instructions on patch submission).
>  To subscribe to the list, send an email with just "subscribe git" in
>  the body to majordomo@vger.kernel.org. The mailing list archives are
>  available at http://news.gmane.org/gmane.comp.version-control.git/,
> @@ -50,3 +50,10 @@ The maintainer frequently sends the "What's cooking" reports that
>  list the current status of various development topics to the mailing
>  list.  The discussion following them give a good reference for
>  project status, development direction and remaining tasks.
> +
> +[INSTALL]: INSTALL
> +[Documentation/gittutorial.txt]: Documentation/gittutorial.txt
> +[Documentation/giteveryday.txt]: Documentation/giteveryday.txt
> +[Documentation/git-commandname.txt]: Documentation/git-commandname.txt
> +[Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt
> +[Documentation/SubmittingPatches]: Documentation/SubmittingPatches