From: Junio C Hamano <gitster@pobox.com>
Date: Fri, 16 Mar 2012 04:54:30 +0000 (-0700)
Subject: Merge branch 'th/doc-diff-submodule-option'
X-Git-Tag: v1.7.10-rc2~12
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/c58499c317ccb04aba4e0c5b3bee78683027f095?hp=0e2d57fd50f61e668be3180bc8f25991ea88aa8c

Merge branch 'th/doc-diff-submodule-option'

* th/doc-diff-submodule-option:
Documentation/diff-options: reword description of --submodule option
---

diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index 7d4566f829..378f19f0e2 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.