Skip to content

Commit c58499c

Browse files
committed
Merge branch 'th/doc-diff-submodule-option'
* th/doc-diff-submodule-option: Documentation/diff-options: reword description of --submodule option
2 parents 0e2d57f + 3fe271e commit c58499c

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
@@ -165,11 +165,12 @@ any of those replacements occurred.
165165
of the `--diff-filter` option on what the status letters mean.
166166

167167
--submodule[=<format>]::
168-
Chose the output format for submodule differences. <format> can be one of
169-
'short' and 'log'. 'short' just shows pairs of commit names, this format
170-
is used when this option is not given. 'log' is the default value for this
171-
option and lists the commits in that commit range like the 'summary'
172-
option of linkgit:git-submodule[1] does.
168+
Specify how differences in submodules are shown. When `--submodule`
169+
or `--submodule=log` is given, the 'log' format is used. This format lists
170+
the commits in the range like linkgit:git-submodule[1] `summary` does.
171+
Omitting the `--submodule` option or specifying `--submodule=short`,
172+
uses the 'short' format. This format just shows the names of the commits
173+
at the beginning and end of the range.
173174

174175
--color[=<when>]::
175176
Show colored diff.

0 commit comments

Comments
 (0)