summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Henigan <tim.henigan@gmail.com>2012-03-14 17:00:55 (GMT)
committerJunio C Hamano <gitster@pobox.com>2012-03-14 19:15:46 (GMT)
commit3fe271e91b4d1b9ed0b304e218df8fd419012107 (patch)
treebb1a91bf81f9f704244e2fd2e2ddc92843fd9486
parent752c0c24926aacbceca0d27de6ad22cbb7dd0709 (diff)
downloadgit-3fe271e91b4d1b9ed0b304e218df8fd419012107.zip
git-3fe271e91b4d1b9ed0b304e218df8fd419012107.tar.gz
git-3fe271e91b4d1b9ed0b304e218df8fd419012107.tar.bz2
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>
-rw-r--r--Documentation/diff-options.txt11
1 files changed, 6 insertions, 5 deletions
diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index e26b847..286d84d 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -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.