summaryrefslogtreecommitdiff
path: root/git-debrebase.5.pod
diff options
context:
space:
mode:
authorIan Jackson <ijackson@chiark.greenend.org.uk>2018-07-31 13:52:03 +0100
committerIan Jackson <ijackson@chiark.greenend.org.uk>2018-07-31 13:52:06 +0100
commit0057ec1d2d864bbd40a5fcc32a5edeeb2bc90b4e (patch)
treefeb518acd5ac878a32ef2017af46f452130c6516 /git-debrebase.5.pod
parent1146c44cdb7a593d61318b9db4da82e51cbd476c (diff)
git-debrebase(5): Add ILLEGAL OPERATIONS section.
Re #905004. Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
Diffstat (limited to 'git-debrebase.5.pod')
-rw-r--r--git-debrebase.5.pod42
1 files changed, 42 insertions, 0 deletions
diff --git a/git-debrebase.5.pod b/git-debrebase.5.pod
index 52fb60b..d39ad94 100644
--- a/git-debrebase.5.pod
+++ b/git-debrebase.5.pod
@@ -487,6 +487,48 @@ These patch files can be stripped out and/or regenerated as needed.
=back
+=head1 ILLEGAL OPERATIONS
+
+Some git operations are not permitted in this data model.
+Performing them will break git-debrebase.
+
+=over
+
+=item General merges
+
+See L</OTHER MERGES>, above.
+
+=item git-rebase starting too soon, or without base argument
+
+git-rebase must not be invoked in such a way that
+the chosen base is before the anchor,
+or before the last pseudomerge.
+This is because git-rebase mangles merges.
+git rebase --preserve-merges is also dangerous.
+
+git-rebase without a base argument will often start too early.
+
+For these reasons,
+it is better to use git-debrebase and
+let it choose the base
+for your rebase.
+If you do realise you have make this mistake,
+it is best to use the reflog to recover to a suitable
+good previous state.
+
+=item Editing debian/patches
+
+debian/patches is an output from git-debrebase,
+not an input.
+If you edit patches git-debrebase will complain
+and refuse to work.
+If you add patches your work is likely to be discarded.
+
+Instead of editing patches,
+use git-debrebase to edit the corresponding commits.
+
+=back
+
=head1 COMMIT MESSAGE ANNOTATIONS
git-debrebase makes annotations