[PATCH v3 4/4] git-submodule: New subcommand 'summary' (4) - Update the document
Signed-off-by: Ping Yin <pkufranky@gmail.com>
---
Documentation/git-submodule.txt | 24 +++++++++++++++++++++---
1 files changed, 21 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index e818e6e..598e116 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -12,6 +12,7 @@ SYNOPSIS
'git-submodule' [--quiet] add [-b branch] [--] <repository> [<path>]
'git-submodule' [--quiet] status [--cached] [--] [<path>...]
'git-submodule' [--quiet] [init|update] [--] [<path>...]
+'git-submodule' [--quiet] summary [--summary-limit <n>] [commit] [--] [<path>...]
COMMANDS
@@ -46,6 +47,13 @@ update::
checkout the commit specified in the index of the containing repository.
This will make the submodules HEAD be detached.
+summary::
+ Show commit summary between given commit (default to HEAD) and
+ working tree/index. For a submodule in question, a series of commits
+ will be shown as the path from the src commit to the dst commit,
+ where the src commit is from the given super project commit, and the
+ dst commit is from the index or working tree (switched by --cached).
+
OPTIONS
-------
@@ -56,9 +64,19 @@ OPTIONS
Branch of repository to add as submodule.
--cached::
- Display the SHA-1 stored in the index, not the SHA-1 of the currently
- checked out submodule commit. This option is only valid for the
- status command.
+ This option is only valid for commands status and summary.
+ When combined with status, display the SHA-1 stored in the index,
+ not the SHA-1 of the currently checked out submodule commit. When
+ combined with summary, switch dst comparison side from working
+ tree to index.
+
+-n, --summary-limit::
+ This option is only valid for the summary command.
+ Limit the summary size (number of commits shown in total).
+ Number 0 will disable summary and minus number means unlimted
+ (the default). For beauty and clarification, the fork-point commits
+ will always be shown. So actual summary size may be greater than
+ the given limit.
<path>::
Path to submodule(s). When specified this will restrict the command
--
1.5.4.3.347.g5314c
Ping Yin <pkufranky@gmail.com>