Re: [PATCH] rebase -i -p: document shortcomings
- From
Jonathan Nieder <jrnieder@gmail.com>
- Date
- Jun 1, 2010, 08:50 UTC
- Message-ID
- <20100601085005.GA32320@progeny.tock>
- In-Reply-To
- <AANLkTimjcHpbbpfwNoZGq3_1TjfLAzJL3C8Jcp6LeyW0@mail.gmail.com>
Hi Greg,
Greg Price wrote:
> The combination "rebase -i -p" does work correctly in one common use > case:
[...]
> I suggest s/instruction sheet/todo list/, as the latter terminology > seems more natural to me
Here’s a rough patch to squash in. Thanks for the ideas.
Sleepily, Jonathan
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt index 330e9ea..e27099e 100644 --- a/Documentation/git-rebase.txt +++ b/Documentation/git-rebase.txt @@ -309,7 +309,7 @@ link:howto/revert-a-faulty-merge.txt[revert-a-faulty-merge How-To] for details). + This uses the `--interactive` machinery internally, but combining it with the `--interactive` option explicitly is generally not a good -idea (see BUGS below). +idea unless you know what you are doing (see BUGS below). --root:: @@ -614,9 +614,10 @@ case" recovery too! BUGS ---- -The instruction sheet presented by `--preserve-merges --interactive` -does not represent the topology of the revision graph. Attempts to -reorder it tend to produce counterintuitive results. +The todo list presented by `--preserve-merges --interactive` does not +represent the topology of the revision graph. Editing commits and +rewording their commit messages should work fine, but attempts to +reorder commits tend to produce counterintuitive results. For example, an attempt to rearrange ------------
-- 1.7.1.246.g2fc1b.dirty