Re: [PATCH] Documentation/log: clarify what --raw means

From: Eric Sunshine <sunshine@sunshineco.com>
Date: May 15, 2015, 17:29 UTC
Message-ID: <CAPig+cTWipduPMXg-3uxgaBo_VkzGQdHe-D72EuN93B3dWzbmQ@mail.gmail.com>
In-Reply-To: <1431704674-18595-1-git-send-email-Matthieu.Moy@imag.fr>

On Fri, May 15, 2015 at 11:44 AM, Matthieu Moy <Matthieu.Moy@imag.fr> wrote:

Show 5 quoted lines

> There are several "raw formats", and describing --raw as "Generate the
> raw format" in the documentation for git-log seems to imply that it
> generates the raw *log* format.
>
> Clarify the wording by saying "raw diff format" explicitely, and make a

s/explicitely/explicitly/

Show 30 quoted lines

> special-case for "git log": "git log --raw" does not just change the
> format, it shows something which is not shown by default.
>
> Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
> ---
> diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
> index ccd4998..163163b 100644
> --- a/Documentation/diff-options.txt
> +++ b/Documentation/diff-options.txt
> @@ -41,8 +41,17 @@ endif::git-format-patch[]
>
>  ifndef::git-format-patch[]
>  --raw::
> -       Generate the raw format.
> +ifndef::git-log[]
> +       Generate the raw diff format.
>         {git-diff-core? This is the default.}
> +endif::git-log[]
> +ifdef::git-log[]
> +       For each commit, show a summary of changes using the raw diff
> +       format. See the "RAW OUTPUT FORMAT" section of
> +       linkgit:git-diff[1]. This is different from showing the log
> +       itself in raw format, which you can achieve with
> +       `--format=raw`.
> +endif::git-log[]
>  endif::git-format-patch[]
>
>  ifndef::git-format-patch[]
> --
> 2.3.5.2.ge515092.dirty