Re: [PATCH v5 05/12] doc: revisions: extra clarification of <rev>^! notation effects

From: Philip Oakley <philipoakley@iee.org>
Date: Aug 12, 2016, 22:17 UTC
Message-ID: <38431C3FB1444813A222858D8F4D0390@PhilipOakley>
In-Reply-To: <c3271034-8fc5-3e29-ea1a-1c543abc7c52@xiplink.com>

From: "Marc Branchaud" <marcnarc@xiplink.com>

Show 24 quoted lines

> On 2016-08-12 03:07 AM, Philip Oakley wrote:
>> Signed-off-by: Philip Oakley <philipoakley@iee.org>
>> ---
>> new
>> Cc: Jakub Narębski <jnareb@gmail.com>
>> https://public-inbox.org/git/578E4F4A.2020708%40gmail.com/
>> ---
>>  Documentation/revisions.txt | 3 ++-
>>  1 file changed, 2 insertions(+), 1 deletion(-)
>>
>> diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
>> index 3da0083..0b5044d 100644
>> --- a/Documentation/revisions.txt
>> +++ b/Documentation/revisions.txt
>> @@ -281,7 +281,8 @@ for naming a set that is formed by a commit and its 
>> parent commits.
>>
>>  The 'r1{caret}@' notation means all parents of 'r1'.
>>
>> -'r1{caret}!' includes commit 'r1' but excludes all of its parents.
>> +'r1{caret}!' notation includes commit 'r1' but excludes all of its 
>> parents.
>
> This sentence should start with "The".

Accepted. I'd simply split the the previous text, so the nice run-on effect it initially had has been lost.

Show 6 quoted lines

>
>> +This is the single commit 'r1', if standalone.
>
> That reads awkwardly to me.  Perhaps
>
>        By itself, this notation denotes the single commit 'r1'.

Like it. I'd toyed wth quite a few variants. It's jsut a case of finding the nicest one;-)

Show 6 quoted lines

>
> ?
>
> M.
>
> --

Philip