Re: [PATCH] Fix minor typo in git-diff docs.

From: Junio C Hamano <gitster@pobox.com>
Date: Jul 31, 2017, 16:52 UTC
Message-ID: <xmqqy3r4im5y.fsf@gitster.mtv.corp.google.com>
In-Reply-To: <CA+dzEB=cDvp7ZS8x+p+U-5NbK3SNd0FPyj_wP=gvi8mJi6D2ag@mail.gmail.com>

Anthony Sottile <asottile@umich.edu> writes:

> To be honest, I'm a bit overwhelmed by the documentation for submitting a patch!
>
> I tried to follow as best I could, here's my attempt (please advise).

OK ;-)  Thanks for a patch.  Let's nitpick.

Our titles (your "Subject:" line in the e-mail header) state the area, colon and then a one line summary and ends without the final full stop, e.g.

    Subject: [PATCH] diff-options: grammar fix

Show 5 quoted lines

>
> From e88ad689a7587c11f270a10f191a3b6bc52a90d4 Mon Sep 17 00:00:00 2001
> From: Anthony Sottile <asottile@umich.edu>
> Date: Mon, 31 Jul 2017 06:54:14 -0700
> Subject: [PATCH] Fix minor typo in git-diff docs.

Generally these do not belong to the body of the message.

What object name the commit has locally in your repository is immaterial. Whose change it is, when it was shown to the general public for the first time, and what the title of the change is, are all in the e-mail header of your message.

One exception is when you cannot convince your e-mail client to put the name under which you sign-off the patch on the "From: " line in your e-mail header, or you are relaying somebody else's patch. You can then have "From: " line to record the right name, a blank line and then write body of the message.

>
> Signed-off-by: Anthony Sottile <asottile@umich.edu>

The space above "Signed-off-by: " is to describe what the change is about, when the title is not clear enough, but I think there is no need for such extra explanation for this particular patch.

Thanks for correcting my grammar.  Will queue with a tweaked title.

Show 17 quoted lines

> ---
>  Documentation/diff-options.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
> index 89cc0f4..43d18a4 100644
> --- a/Documentation/diff-options.txt
> +++ b/Documentation/diff-options.txt
> @@ -392,7 +392,7 @@ endif::git-log[]
>         the diff between the preimage and `/dev/null`. The resulting patch
>         is not meant to be applied with `patch` or `git apply`; this is
>         solely for people who want to just concentrate on reviewing the
> -       text after the change. In addition, the output obviously lack
> +       text after the change. In addition, the output obviously lacks
>         enough information to apply such a patch in reverse, even manually,
>         hence the name of the option.
>  +