git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Matthieu Moy <Matthieu.Moy@imag.fr>
To: gitster@pobox.com
Cc: git@vger.kernel.org, Matthieu Moy <Matthieu.Moy@imag.fr>
Subject: [PATCH v2 1/2] Documentation/log: clarify what --raw means
Date: Mon, 18 May 2015 19:55:57 +0200	[thread overview]
Message-ID: <1431971758-979-1-git-send-email-Matthieu.Moy@imag.fr> (raw)
In-Reply-To: <xmqqtwvdhhb2.fsf@gitster.dls.corp.google.com>

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>
---
Since v1: Reworded after Junio's remark, typo fix thanks to Eric Sunshine.

 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..a1a5868 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 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[]
-- 
2.3.5.2.ge515092.dirty

  parent reply	other threads:[~2015-05-18 17:56 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
2015-05-18 17:51           ` Matthieu Moy
2015-05-18 17:55           ` Matthieu Moy [this message]
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=1431971758-979-1-git-send-email-Matthieu.Moy@imag.fr \
    --to=matthieu.moy@imag.fr \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
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;
as well as URLs for NNTP newsgroup(s).