git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Michael J Gruber <git@drmicha.warpmail.net>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>
Subject: [PATCH 2/2] git-rev-list.txt: Clarify the use of multiple revision arguments
Date: Wed,  5 Aug 2009 09:58:37 +0200	[thread overview]
Message-ID: <1249459117-3853-2-git-send-email-git@drmicha.warpmail.net> (raw)
In-Reply-To: <1249459117-3853-1-git-send-email-git@drmicha.warpmail.net>

If one thinks of a revision as the set of commits which can be reached
from the rev, and of ^rev as the complement, then multiple arguments to
git rev-list can be neither understood as the intersection nor the union
of the individual sets.

But set language is the natural as well as logical language in which to
phrase this. So, add a paragraph which explains multiple arguments using
set language.

Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
---
While one could explain this also by describing the revision walker,
I think that and/or/union/intersection should be clearer for the average
user.

We may even want to add a paragraph which explains how one gets "A intersected B",
which is impossible to do with rev-list.

 Documentation/git-rev-list.txt |    7 +++++++
 1 files changed, 7 insertions(+), 0 deletions(-)

diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt
index 847cc7d..40ca276 100644
--- a/Documentation/git-rev-list.txt
+++ b/Documentation/git-rev-list.txt
@@ -66,6 +66,13 @@ command:
 means "list all the commits which are included in 'foo' or 'bar', but
 not in 'baz'".
 
+So, the resulting set of commits is the union of 'foo' and 'bar',
+intersected with the complement of baz. The order of arguments is
+irrelevant: first, the union of all positive refs (those without
+'{caret}') is taken, then the result is intersected with all negative
+refs (i.e. with the complement of the union of all refs which appear
+with a preceding '{caret}').
+
 A special notation "'<commit1>'..'<commit2>'" can be used as a
 short-hand for "{caret}'<commit1>' '<commit2>'". For example, either of
 the following may be used interchangeably:
-- 
1.6.4.70.g9c084

  reply	other threads:[~2009-08-05  7:59 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-08-05  7:58 [PATCH 1/2] git-rev-list.txt: Correct description for multiple arguments Michael J Gruber
2009-08-05  7:58 ` Michael J Gruber [this message]
2009-08-05 16:42   ` [PATCH 2/2] git-rev-list.txt: Clarify the use of multiple revision arguments Junio C Hamano
2009-08-06  8:48     ` Michael J Gruber

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=1249459117-3853-2-git-send-email-git@drmicha.warpmail.net \
    --to=git@drmicha.warpmail.net \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.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).