Skip to content

Commit 3fe271e

Browse files
thenigangitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 752c0c2 commit 3fe271e

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

Documentation/diff-options.txt

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -88,11 +88,12 @@ endif::git-format-patch[]
8888
of the `--diff-filter` option on what the status letters mean.
8989

9090
--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.
9697

9798
--color::
9899
Show colored diff.

0 commit comments

Comments
 (0)