git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Ping Yin <pkufranky@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH v3 4/4] git-submodule summary: documentation
Date: Sat, 08 Mar 2008 01:37:58 -0800	[thread overview]
Message-ID: <7vpru5v9mx.fsf@gitster.siamese.dyndns.org> (raw)
In-Reply-To: 1204914439-23145-4-git-send-email-pkufranky@gmail.com

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.
 




  reply	other threads:[~2008-03-08  9:39 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-03-07 18:27 [PATCH v3 1/4] git-submodule summary: code framework Ping Yin
2008-03-07 18:27 ` [PATCH v3 2/4] git-submodule summary: show commit summary Ping Yin
2008-03-07 18:27   ` [PATCH v3 3/4] git-submodule summary: limit summary size Ping Yin
2008-03-07 18:27     ` [PATCH v3 4/4] git-submodule summary: documentation Ping Yin
2008-03-08  9:37       ` Junio C Hamano [this message]
2008-03-09 13:12         ` Ping Yin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=7vpru5v9mx.fsf@gitster.siamese.dyndns.org \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=pkufranky@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).