Re: [PATCH v3 4/4] git-submodule summary: documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



I've replaced the previous series in 'pu' with this series and queued in
'pu', but with a few wording fixes.

I didn't closely look at the script itself yet.  I thinkthe series is
getting closer to a mergeable shape, but it needs tests.

 Documentation/git-submodule.txt |   17 +++++++----------
 1 files changed, 7 insertions(+), 10 deletions(-)

diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 4fbc182..e96bf36 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -48,11 +48,10 @@ update::
 	This will make the submodules HEAD be detached.
 
 summary::
-	Show commit summary between given commit (default to HEAD) and
+	Show commit summary between the given commit (defaults to HEAD) and
 	working tree/index. For a submodule in question, a series of commits
-	between src sha1 and dst sha1 will be shown where src sha1 is from the
-	given super project commit and dst sha1 is from the index or working
-	tree (switched by --cached).
+	in the submodule between the given super project commit and the
+	index or working tree (switched by --cached) are shown.
 
 OPTIONS
 -------
@@ -63,16 +62,14 @@ OPTIONS
 	Branch of repository to add as submodule.
 
 --cached::
-	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.
+	This option is only valid for status and summary commands.  These
+	commands typically use the commit found in the submodule HEAD, but
+	with this option, the commit stored in the index is used instead.
 
 -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
+	Giving 0 will disable the summary; a negative number means unlimted
 	(the default). This limit only applies to modified submodules. The
 	size is always limited to 1 for added/deleted/typechanged submodules.
 



--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux