Skip to content

Commit

Permalink
Documentation/log: clarify what --raw means
Browse files Browse the repository at this point in the history
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" explicitly, 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.

Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Matthieu Moy authored and Junio C Hamano committed May 18, 2015
1 parent 282616c commit d89df36
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion Documentation/diff-options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,17 @@ endif::git-format-patch[]

ifndef::git-format-patch[]
--raw::
Generate the raw format.
ifndef::git-log[]
Generate the diff in raw 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[]
Expand Down

0 comments on commit d89df36

Please sign in to comment.