public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox•com>
To: Matthieu Moy <Matthieu.Moy@imag•fr>
Cc: git@vger•kernel.org, eda@waniasset•com
Subject: Re: [PATCH] Documentation/log: clarify what --raw means
Date: Fri, 15 May 2015 10:38:41 -0700	[thread overview]
Message-ID: <xmqqtwvdhhb2.fsf@gitster.dls.corp.google.com> (raw)
In-Reply-To: <1431704674-18595-1-git-send-email-Matthieu.Moy@imag.fr> (Matthieu Moy's message of "Fri, 15 May 2015 17:44:34 +0200")

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

> 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
> special-case for "git log": "git log --raw" does not just change the
> format, it shows something which is not shown by default.

Being a pedant, I find "generate the raw diff format" somewhat a
strange wording.  Aren't we generating a diff in the raw format (as
opposed to in other format like the textual patch format),
generating a diff using the raw format, etc.?

In any case, this is an improvement.  Thanks.  Will queue.

> Signed-off-by: Matthieu Moy <Matthieu.Moy@imag•fr>
> ---
>  Documentation/diff-options.txt | 11 ++++++++++-
>  1 file changed, 10 insertions(+), 1 deletion(-)
>
> 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[]

  parent reply	other threads:[~2015-05-15 17:38 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-15 14:46 git log --raw abbreviates SHA1s, despite what manual says Ed Avis
2015-05-15 15:08 ` Matthieu Moy
2015-05-15 15:22   ` Ed Avis
2015-05-15 15:33     ` Ed Avis
2015-05-15 15:42     ` Matthieu Moy
2015-05-15 15:44       ` [PATCH] Documentation/log: clarify what --raw means Matthieu Moy
2015-05-15 15:47         ` Ed Avis
2015-05-15 17:44           ` Junio C Hamano
2015-05-15 17:29         ` Eric Sunshine
2015-05-15 17:38         ` Junio C Hamano [this message]
2015-05-18 17:51           ` Matthieu Moy
2015-05-18 17:55           ` [PATCH v2 1/2] " Matthieu Moy
2015-05-18 17:55             ` [PATCH v2 2/2] Documentation/log: clarify sha1 non-abbreviation in log --raw Matthieu Moy
2015-05-18 20:52               ` Junio C Hamano
2015-05-18 21:28                 ` Matthieu Moy
2015-05-18 22:29                   ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqtwvdhhb2.fsf@gitster.dls.corp.google.com \
    --to=gitster@pobox$(echo .)com \
    --cc=Matthieu.Moy@imag$(echo .)fr \
    --cc=eda@waniasset$(echo .)com \
    --cc=git@vger$(echo .)kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox