[PATCH v2] Documentation/diff-options: reword description of --submodule option

From

Tim Henigan <tim.henigan@gmail.com>

Date

Mar 14, 2012, 17:00 UTC

Message-ID

<1331744455-624-1-git-send-email-tim.henigan@gmail.com>

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

Changes in v2:
  - v1 was a series of two patches. The first was a simple typo fix
    (s/Chose/Choose/). v2 eliminates the first commit as it is no longer
    needed.
  - Changed wording again based on direction from Junio Hamano.
  - Removed explanation of formats from the commit message. The diff
    now adequately explains how they work.

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

diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index 7d4566f..6aa0907 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -165,11 +165,12 @@ any of those replacements occurred.
 	of the `--diff-filter` option on what the status letters mean.
 
 --submodule[=<format>]::
-	Chose 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.
+	Specify how differences in submodules are shown.  When `--submodule`
+	or `--submodule=log` is given, the 'log' format is used.  This format lists
+	the commits in the range like linkgit:git-submodule[1] `--summary` does.
+	Omitting the `--submodule` option or specifying `--submodule=short`,
+	uses the 'short' format. This format just shows the names of the commits
+	at the beginning and end of the range.
 
 --color[=<when>]::
 	Show colored diff.

-- 
1.7.10.rc0