Re: [PATCH] Clean weird documentation for 'git var' and 'git

From: René Scharfe <rene.scharfe@lsrfire.ath.cx>
Date: May 10, 2012, 17:06 UTC
Message-ID: <4FABF5A2.1050200@lsrfire.ath.cx>
In-Reply-To: <CAGK7Mr7QWrddaRLkr=1h=GYUNtNVOatQF1sj+p11mejzs65u8A@mail.gmail.com>

Am 10.05.2012 18:45, schrieb Philippe Vaucher:

> Here's a patch removing the weird bits. I spoke about in my previous message.

Ideally, a commit message should be self-contained and explain the reasons for the introduced changes, or at least contain a link to a mailing list archive, so that readers who only have the git repository have a chance to follow the arguments.

Show 5 quoted lines

>
> Philippe
>
>
> Signed-off-by: Philippe Vaucher<philippe.vaucher@gmail.com>

The author field of a commit plus the sign-off line are enough to identify you, no extra line with your name required.

Show 23 quoted lines

> ---
>   Documentation/git-commit-tree.txt |    9 ---------
>   Documentation/git-var.txt         |    9 ---------
>   2 files changed, 18 deletions(-)
>
> diff --git a/Documentation/git-commit-tree.txt
> b/Documentation/git-commit-tree.txt
> index cfb9906..eb8ee99 100644
> --- a/Documentation/git-commit-tree.txt
> +++ b/Documentation/git-commit-tree.txt
> @@ -88,15 +88,6 @@ for one to be entered and terminated with ^D.
>
>   include::date-formats.txt[]
>
> -Diagnostics
> ------------
> -You don't exist. Go away!::
> -    The passwd(5) gecos field couldn't be read
> -Your parents must have hated you!::
> -    The passwd(5) gecos field is longer than a giant static buffer.
> -Your sysadmin must hate you!::
> -    The passwd(5) name field is longer than a giant static buffer.
> -

These are actual error messages and their meanings, e.g. git prints "You don't exist. Go away!" in case the gecos field of your account in /etc/passwd (or NIS, or LDAP) couldn't be read.

René