Skip to content

Commit

Permalink
Documentation/diff-options: reword description of --submodule option
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Tim Henigan authored and Junio C Hamano committed Mar 14, 2012
1 parent 752c0c2 commit 3fe271e
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions Documentation/diff-options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -88,11 +88,12 @@ endif::git-format-patch[]
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::
Show colored diff.
Expand Down

0 comments on commit 3fe271e

Please sign in to comment.