Re: [PATCH 3/3] rev-list --min-parents,--max-parents: doc and test and completion
- From
Jeff King <peff@peff.net>
- Date
- Mar 21, 2011, 10:54 UTC
- Message-ID
- <20110321105431.GB16334@sigill.intra.peff.net>
- In-Reply-To
- <4D871401.6020900@drmicha.warpmail.net>
On Mon, Mar 21, 2011 at 10:01:53AM +0100, Michael J Gruber wrote:
Show 9 quoted lines
> >> + Show only commits which have at least resp. at most that many > >> + commits, where `--max-parents=8` denotes infinity (i.e. no upper > >> + limit). In fact, 7 (or any negative number) does, but 8 is > >> + infinity sideways 8-) > > > > I didn't quite parse this "resp." in the middle. > > Well, there are two options (--min-parents, --max-parents) which we > describe in one paragraph. Sooo...
I figured out what you were trying to say. I just had never seen the abbreviation "resp." before. I guessed it meant "respectively", but the syntax is all wrong.
Digging around via google, I was able to find that it is a mathematical term with a specific syntax, but one I had never seen before. Maybe I am just clueless and sheltered, but after 30-odd years of reading English (12 of which involved reading academic computer science papers!), I can't help but think it is not all that common and may confuse other readers. Add on top that it is usually used in parentheses, which helps make it more obvious what is going on.
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.
Show 7 quoted lines
> > 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.
-Peff