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

From: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
Date: May 18, 2015, 17:51 UTC
Message-ID: <vpqmw11vkns.fsf@anie.imag.fr>
In-Reply-To: <xmqqtwvdhhb2.fsf@gitster.dls.corp.google.com>

Junio C Hamano <gitster@pobox.com> writes:

Show 14 quoted lines

> 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.?

I think I chose this wording because I didn't want to say "raw format" for git-log(1), but then I added more special-cases for git-log.

I changed it to

ifndef::git-log[]
	Generate the diff in raw format.
	{git-diff-core? This is the default.}

-- 
Matthieu Moy
http://www-verimag.imag.fr/~moy/