From: Michael J Gruber <git@drmicha.warpmail.net>
To: Junio C Hamano <gitster@pobox.com>
Cc: Jeff King <peff@peff.net>, git@vger.kernel.org
Subject: Re: [PATCH 3/3] rev-list --min-parents,--max-parents: doc and test and completion
Date: Mon, 21 Mar 2011 15:56:20 +0100 [thread overview]
Message-ID: <4D876714.8040604@drmicha.warpmail.net> (raw)
In-Reply-To: <7vbp14ttgu.fsf@alter.siamese.dyndns.org>
Junio C Hamano venit, vidit, dixit 21.03.2011 15:54:
> Michael J Gruber <git@drmicha.warpmail.net> writes:
>
>> Jeff King venit, vidit, dixit 21.03.2011 11:54:
>>> On Mon, Mar 21, 2011 at 10:01:53AM +0100, Michael J Gruber wrote:
>>>
>> In my community it is very common, which may partly be due to the fact
>> that there is a strong proportion of non-native speakers. It took it for
>> granted that it's a standard expression.
>
> Perhaps in math circles or something?
Yeah, those (us) weirdos ;)
>
>>> I really think "Show only commits which have at least (or at most,
>>> respectively) that many commits" says the same thing, but is way more
>>> accessible.
>>
>> Sounds good, I'm happy with that. Resend or squash on apply?
>
> The "... A resp. B" composition did made me go "huh?", even though I
> managed to guess what you meant; I agree Jeff's rewrite is much more
> approacheable.
>
> The code part of the patch needs a bit of touch-up anyway, so let's do a
> v2.
>
> It is not like you will have a million copies of "struct rev_info", while
> you will be reading from and comparing with the field for each commit
> during the traversal, so I'd rather see these max/min stored in the usual
> "int", not squashed into bitfields. Also initialize max to the magic
> token that means "unlimited" in init_revisions() without swapping the
> meaning of comparison. One initialization assignment you can omit there
> is not worth the resulting confusion.
>
>>>>> That way it is obvious that "--merges" cancels a previous --min-parents
>>>>> on the command line (maybe the text should be "this is an alias for..."
>>>>> to make it clear that doing it is exactly the same).
>>>>
>>>> Yes, that is helpful. I have doubts about "alias" for. Without wanting
>>>> to sound elitist or something, I have the impression that we start
>>>> catering for users who understand "equivalent" more reliably than "alias".
>>>
>>> I just wanted to make sure people didn't think "equivalent" meant "has a
>>> similar effect to" as opposed to "is exactly as if you did". But reading
>>> it again, I think "equivalent" is fine, and I see you picked it up in
>>> the latest series.
>>
>> I may be wrong about what is common in this case, too. For me, "alias"
>> is foremost a technical term, and I would guess that many non-native
>> speaker know "alias" either in the technical sense or not at all, but
>> not so much in the common English sense. But either way is fine.
>
> We would want to make sure the reader understands that saying --no-merges
> is _exactly the same_ (your words above) as saying --max-parents=1, so why
> not spell that out, i.e. "This is exactly the same as `--max-parents=1`"?
>
> Thanks.
I guess you haven't seen v2 yet, where most of these changes are
incorporated.
For the doc, "exactly the same" is clean and simple and understandable
for both Jeff and myself, I guess ;)
Michael
next prev parent reply other threads:[~2011-03-21 14:59 UTC|newest]
Thread overview: 67+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-03-17 11:33 [PATCH/RFD 0/2] revision.c: --merges, --no-merges and --merges-only Michael J Gruber
2011-03-17 11:33 ` [PATCH/RFD 1/2] revision.c: rename --merges to --merges-only Michael J Gruber
2011-03-17 11:33 ` [PATCH/RFD 2/2] revision.c: introduce --merges to undo --no-merges Michael J Gruber
2011-03-17 19:23 ` [PATCH/RFD 0/2] revision.c: --merges, --no-merges and --merges-only Junio C Hamano
2011-03-17 19:59 ` Jeff King
2011-03-18 7:56 ` Michael J Gruber
2011-03-18 8:22 ` Junio C Hamano
2011-03-18 8:41 ` Michael J Gruber
2011-03-18 8:56 ` Jeff King
2011-03-18 14:50 ` [PATCH 0/3] rev-list and friends: --min-parents, --max-parents Michael J Gruber
2011-03-18 14:50 ` [PATCH 1/3] revision.c: introduce --min-parents and --max-parents Michael J Gruber
2011-03-18 19:34 ` Jeff King
2011-03-21 7:31 ` Michael J Gruber
2011-03-18 20:48 ` Jonathan Nieder
2011-03-18 21:21 ` Junio C Hamano
2011-03-21 9:26 ` Michael J Gruber
2011-03-18 14:50 ` [PATCH 2/3] t6009: use test_commit() from test-lib.sh Michael J Gruber
2011-03-18 14:50 ` [PATCH 3/3] rev-list --min-parents,--max-parents: doc and test and completion Michael J Gruber
2011-03-18 19:48 ` Jeff King
2011-03-21 9:01 ` Michael J Gruber
2011-03-21 10:54 ` Jeff King
2011-03-21 12:06 ` Michael J Gruber
2011-03-21 14:54 ` Junio C Hamano
2011-03-21 14:56 ` Michael J Gruber [this message]
2011-03-21 16:47 ` Junio C Hamano
2011-03-18 21:14 ` Jonathan Nieder
2011-03-21 8:52 ` Michael J Gruber
2011-03-21 17:49 ` Jonathan Nieder
2011-03-22 7:38 ` Michael J Gruber
2011-03-18 14:54 ` [PATCH 0/3] rev-list and friends: --min-parents, --max-parents Michael J Gruber
2011-03-18 19:41 ` Jeff King
2011-03-21 7:42 ` Michael J Gruber
2011-03-21 10:14 ` [PATCHv2 " Michael J Gruber
2011-03-21 10:14 ` [PATCHv2 1/3] t6009: use test_commit() from test-lib.sh Michael J Gruber
2011-03-21 10:14 ` [PATCHv2 2/3] revision.c: introduce --min-parents and --max-parents Michael J Gruber
2011-03-21 14:04 ` Michael J Gruber
2011-03-21 17:45 ` Junio C Hamano
2011-03-21 17:58 ` Jonathan Nieder
2011-03-21 10:14 ` [PATCHv2 3/3] rev-list --min-parents,--max-parents: doc and test and completion Michael J Gruber
2011-03-21 18:45 ` Jonathan Nieder
2011-03-22 7:55 ` Michael J Gruber
2011-03-23 0:47 ` Jonathan Nieder
2011-03-21 10:56 ` [PATCHv2 0/3] rev-list and friends: --min-parents, --max-parents Jeff King
2011-03-23 9:38 ` [PATCHv3 0/5]rev-list " Michael J Gruber
2011-03-23 9:38 ` [PATCHv3 1/5] t6009: use test_commit() from test-lib.sh Michael J Gruber
2011-03-23 9:38 ` [PATCHv3 2/5] revision.c: introduce --min-parents and --max-parents Michael J Gruber
2011-03-23 9:38 ` [PATCHv3 3/5] squash! " Michael J Gruber
2011-03-23 9:38 ` [PATCHv3 4/5] rev-list --min-parents,--max-parents: doc, test and completion Michael J Gruber
2011-03-23 9:38 ` [PATCHv3 5/5] fixup! " Michael J Gruber
2011-03-23 14:48 ` [PATCHv3 0/5]rev-list and friends: --min-parents, --max-parents Jeff King
2011-03-23 17:12 ` Junio C Hamano
2011-03-23 18:06 ` Junio C Hamano
2011-03-24 8:21 ` Jonathan Nieder
2011-03-24 8:55 ` Michael J Gruber
2011-03-24 9:42 ` Jonathan Nieder
2011-08-08 1:13 ` [PATCH/RFC 0/2] test_when_finished and returning early Jonathan Nieder
2011-08-08 1:15 ` [PATCH 1/2] test: simplify return value of test_run_ Jonathan Nieder
2011-08-08 1:17 ` [PATCH 2/2] test: cope better with use of return for errors Jonathan Nieder
2011-08-09 8:46 ` Johannes Sixt
2011-08-09 15:36 ` Jeff King
2011-08-11 7:05 ` [PATCH v2] t3900: do not reference numbered arguments from the test script Johannes Sixt
2011-08-11 7:11 ` Jonathan Nieder
2011-08-11 21:49 ` Junio C Hamano
2011-08-08 1:26 ` [PATCH/RFC 0/2] test_when_finished and returning early Jeff King
2011-03-18 9:07 ` [PATCH/RFD 0/2] revision.c: --merges, --no-merges and --merges-only Jeff King
2011-03-18 9:42 ` Michael J Gruber
2011-03-18 9:54 ` Jeff King
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=4D876714.8040604@drmicha.warpmail.net \
--to=git@drmicha.warpmail.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
/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).