|author||Ian Jackson <firstname.lastname@example.org>||2018-11-08 00:38:22 +0000|
|committer||Ian Jackson <email@example.com>||2018-11-08 00:39:28 +0000|
git-debrebase: Document scope of convert-from-gbp
In fact this works with any kind of patches-unapplied (or patchless) package. Signed-off-by: Ian Jackson <firstname.lastname@example.org>
1 files changed, 25 insertions, 8 deletions
diff --git a/git-debrebase.1.pod b/git-debrebase.1.pod
index 04a57ee..a964180 100644
@@ -256,16 +256,33 @@ using dgit quilt-fixup instead should succeed.
=item git-debrebase convert-from-gbp [<upstream-commit-ish>]
-Cnnverts a gbp patches-unapplied branch
-(not a gbp pq patch queue branch)
-into a git-debrebase interchange branch.
+Cnnverts any of the following into a git-debrebase interchange branch:
-This is done by generating a new anchor merge,
-converting the quilt patches as a delta queue,
+a gbp patches-unapplied branch (but not a gbp pq patch-queue branch)
+a patches-unapplied git packaging branch containing debian/patches,
+as used with quilt
+a git branch for a package which has no Debian delta -
+ie where upstream files are have not been modified in Debian,
+so there are no patches
+The conversion is done by generating a new anchor merge,
+converting any quilt patches as a delta queue,
and dropping the patches from the tree.
The upstream commit-ish should correspond to
-the gbp upstream branch, if there is one.
+the upstream branch or tag, if there is one.
It is a snag if it is not an ancestor of HEAD,
or if the history between the upstream and HEAD
contains commits which make changes to upstream files.
@@ -284,14 +301,14 @@ and if it finds it will make a pseduomerge so that
your new git-debrebase view is appropriately fast forward.
The result is a well-formed git-debrebase interchange branch.
-The result is also fast-forward from the gbp branch.
+The result is also fast-forward from the original branch.
It is a snag if the new branch looks like it will have diverged,
just as for a laundering/unstitching call to git-debrebase;
See L</Establish the current branch's ffq-prev>, below.
Note that it is dangerous not to know whether you are
-dealing with a gbp patches-unapplied branch containing quilt patches,
+dealing with a (gbp) patches-unapplied branch containing quilt patches,
or a git-debrebase interchange branch.
using the wrong tool for the branch format might result in