Documentation/diff-options: reword description of --submodule option
The previous description was confusing. This rewrite makes it easier to understand. Signed-off-by: Tim Henigan <tim.henigan@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Tim Henigan committed
Mar 14, 2012 at 13:00 UTC
3fe271e91b4d1b9ed0b304e218df8fd419012107
1 file changed
+6
-5
Documentation/diff-options.txt
+6
-5
@@ -88,11 +88,12 @@ endif::git-format-patch[]
88
of the `--diff-filter` option on what the status letters mean.
89
90
--submodule[=<format>]::
91
- Chose the output format for submodule differences. <format> can be one of
92
- 'short' and 'log'. 'short' just shows pairs of commit names, this format
93
- is used when this option is not given. 'log' is the default value for this
94
- option and lists the commits in that commit range like the 'summary'
95
- option of linkgit:git-submodule[1] does.
91
+ Specify how differences in submodules are shown. When `--submodule`
92
+ or `--submodule=log` is given, the 'log' format is used. This format lists
93
+ the commits in the range like linkgit:git-submodule[1] `summary` does.
94
+ Omitting the `--submodule` option or specifying `--submodule=short`,
95
+ uses the 'short' format. This format just shows the names of the commits
96
+ at the beginning and end of the range.
97
98
--color::
99
Show colored diff.