git-submodule summary: documentation
Signed-off-by: Ping Yin <pkufranky@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ping Yin committed
Mar 11, 2008 at 21:52 UTC
925e7f622d433e1cb2c7556acf8868bb30565a61
1 file changed
+16
-3
Documentation/git-submodule.txt
+16
-3
@@ -12,6 +12,7 @@ SYNOPSIS
12
'git-submodule' [--quiet] add [-b branch] [--] <repository> [<path>]
13
'git-submodule' [--quiet] status [--cached] [--] [<path>...]
14
'git-submodule' [--quiet] [init|update] [--] [<path>...]
15
+'git-submodule' [--quiet] summary [--summary-limit <n>] [commit] [--] [<path>...]
16
17
18
COMMANDS
@@ -46,6 +47,11 @@ update::
47
checkout the commit specified in the index of the containing repository.
48
This will make the submodules HEAD be detached.
49
50
+summary::
51
+ Show commit summary between the given commit (defaults to HEAD) and
52
+ working tree/index. For a submodule in question, a series of commits
53
+ in the submodule between the given super project commit and the
54
+ index or working tree (switched by --cached) are shown.
55
56
OPTIONS
57
-------
@@ -56,9 +62,16 @@ OPTIONS
62
Branch of repository to add as submodule.
63
64
--cached::
59
- Display the SHA-1 stored in the index, not the SHA-1 of the currently
60
- checked out submodule commit. This option is only valid for the
61
- status command.
65
+ This option is only valid for status and summary commands. These
66
+ commands typically use the commit found in the submodule HEAD, but
67
+ with this option, the commit stored in the index is used instead.
68
+
69
+-n, --summary-limit::
70
+ This option is only valid for the summary command.
71
+ Limit the summary size (number of commits shown in total).
72
+ Giving 0 will disable the summary; a negative number means unlimted
73
+ (the default). This limit only applies to modified submodules. The
74
+ size is always limited to 1 for added/deleted/typechanged submodules.
75
76
<path>::
77
Path to submodule(s). When specified this will restrict the command