Re: [RFC PATCH v2 1/7] git-rebase.txt: document incompatible options

From: Elijah Newren <newren@gmail.com>
Date: Jun 20, 2018, 17:10 UTC
Message-ID: <CABPp-BF0Qg8O3cQm51ptB6c7+CKUa+jND6zHdZsixOUMv+2ZxA@mail.gmail.com>
In-Reply-To: <CAPig+cScoXgSrGQseX_u8SaXo1J-beb-fpZpF8V-rpwH5s-AUA@mail.gmail.com>

Hi Eric,

On Sun, Jun 17, 2018 at 10:15 AM, Eric Sunshine <sunshine@sunshineco.com> wrote:

Show 14 quoted lines

> On Sun, Jun 17, 2018 at 1:59 AM Elijah Newren <newren@gmail.com> wrote:
>> git rebase has many options that only work with one of its three backends.
>> It also has a few other pairs of incompatible options.  Document these.
>>
>> Signed-off-by: Elijah Newren <newren@gmail.com>
>> ---
>> diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
>> @@ -487,6 +510,51 @@ recreates the topic branch with fresh commits so it can be remerged
>> +Flags only understood by the interactive backend:
>> + [...]
>> + * --edit-todo
>> + * --root + --onto
>
> What does "+" mean? Is it "and"?

Yes, it means "and", though perhaps it'd be even clearer to write "in combination with" or "when used in combination with"

Show 9 quoted lines

>> +Other incompatible flag pairs:
>> +
>> + * --preserve-merges && --interactive
>> + * --preserve-merges && --signoff
>> + * --preserve-merges && --rebase-merges
>> + * --rebase-merges && --strategy
>
> It's somewhat odd seeing "programmer" notation in end-user
> documentation. Perhaps replace "&&" with "and"?

Yes, good point.  I'll make that fix.