git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Tim Henigan <tim.henigan@gmail.com>
To: git@vger.kernel.org, gitster@pobox.com
Cc: Tim Henigan <tim.henigan@gmail.com>
Subject: [PATCH 2/2] Documentation/diff-options: reword description of --submodule option
Date: Tue, 13 Mar 2012 15:00:51 -0400	[thread overview]
Message-ID: <1331665251-11147-2-git-send-email-tim.henigan@gmail.com> (raw)
In-Reply-To: <1331665251-11147-1-git-send-email-tim.henigan@gmail.com>

The previous description was a bit confusing.  This rewrite makes it
easier to understand.

It should be noted that even though 'log' is listed as the default
format, it is not used when the '--submodule' option is missing. This
means that the output of:
   'git diff'             matches 'git diff --submodule=short'
   'git diff --submodule' matches 'git diff --submodule=log'

Signed-off-by: Tim Henigan <tim.henigan@gmail.com>
---

Resent due to a typo in the developer list email address.

I will understand if this change is rejected, but I found the current
description difficult to follow the first couple times I read it.

 Documentation/diff-options.txt |    9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index f44f3fc..0e1c753 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -165,11 +165,10 @@ any of those replacements occurred.
 	of the `--diff-filter` option on what the status letters mean.
 
 --submodule[=<format>]::
-	Choose the output format for submodule differences. <format> can be one of
-	'short' and 'log'. 'short' just shows pairs of commit names, this format
-	is used when this option is not given. 'log' is the default value for this
-	option and lists the commits in that commit range like the 'summary'
-	option of linkgit:git-submodule[1] does.
+	Choose the output format for submodule differences. <format> can be one
+	of 'short' or 'log'. The default value is 'log'.
+	'log' lists commits in the commit range like linkgit:git-submodule[1] `--summary`.
+	'short' shows only the SHA1 of the source and destination.
 
 --color[=<when>]::
 	Show colored diff.
-- 
1.7.10.rc0

  reply	other threads:[~2012-03-13 19:01 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-03-13 19:00 [PATCH 1/2] Documentation/diff-options: fix typo in --submodule text Tim Henigan
2012-03-13 19:00 ` Tim Henigan [this message]
2012-03-13 20:04   ` [PATCH 2/2] Documentation/diff-options: reword description of --submodule option Junio C Hamano
2012-03-13 20:36     ` Tim Henigan
2012-03-14 18:47       ` Jens Lehmann

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=1331665251-11147-2-git-send-email-tim.henigan@gmail.com \
    --to=tim.henigan@gmail.com \
    --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).