=head1 NAME
-git-debrebase - delta queue rebase tool for Debian packaging
+git-debrebase - tool to maintain series of Debian changes to upstream source
=head1 SYNOPSYS
git-debrebase [<options...>] [-- <git-rebase options...>]
git-debrebase [<options...>] <operation> [<operation options...>
-=head1 INTRODUCTION
+=head1 QUICK REFERENCE
-git-debrebase is a tool for representing in git,
-and manpulating,
-Debian packages based on upstream source code.
+These are most of the commands you will regularly need:
+
+ git debrebase -i # edit the patch queue
+ git debrebase conclude && git push # push to eg salsa
+ git debrebase conclude && dgit push-source # source-only upload
+ git debrebase [-i] new-upstream 1.2.3-1 # uses tag, eg "v1.2.3"
+ dpkg-buildpackage -uc -b # get test debs, at any time
+
+To add patches, or edit the packaging, just make git commits.
+Ignore anything that may appear in debian/patches.
+Avoid using "git pull" and "git merge" without "--ff-only".
+
+git-debrebase has a special branch format, so see
+"CONVERTING AN EXISTING PACKAGE" in L<dgit-maint-debrebase(7)>.
+
+=head1 GUIDE TO DOCUMENTATION
This is the command line reference.
-Please read the tutorial
-L<dgit-maint-debrebase(7)>.
+There is also a detailed workflow tutorial at
+L<dgit-maint-debrebase(7)>
+(on which the above "QUICK REFERENCE" is based).
For background, theory of operation,
and definitions see L<git-debrebase(5)>.
-You should read this manpage in cojnunction with
+You should read this manpage in conjunction with
L<git-debrebase(5)/TERMINOLOGY>,
which defines many important terms used here.
because git-rebase has a tendency to start the rebase
too far back in history,
and then drop important commits.
-Soo L<git-debrebase(5)/ILLEGAL OPERATIONS>
+See L<git-debrebase(5)/ILLEGAL OPERATIONS>
=item git-debrebase status
except for the laundering.
<new-version>
-may be whole new Debian version, including revision,
+may be a whole new Debian version, including revision,
or just the upstream part,
in which case -1 will be appended
to make the new Debian version.
are not a simple superset of those already in debian/patches,
make-patches will fail with exit status 7,
and an error message.
-(The message can be suppress with --quiet-would-amend.)
+(The message can be suppressed with --quiet-would-amend.)
If the problem is simply that
the existing patches were not made by git-debrebase,
using dgit quilt-fixup instead should succeed.
+=item git-debrebase convert-from-unapplied [<upstream-commit-ish>]
+
=item git-debrebase convert-from-gbp [<upstream-commit-ish>]
-Cnnverts any of the following into a git-debrebase interchange branch:
+Converts any of the following into a git-debrebase interchange branch:
=over
=back
+(These two commands operate identically and are simply aliases.)
+
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.
This is provided mostly for the test suite
and for unusual situations.
-It should only be used with a care and
+It should only be used with care and
with a proper understanding of the underlying theory.
Be sure to not accidentally treat the result as
Requests (more) debugging. May be repeated.
-=item --experimntal-merge-resolution
+=item --experimental-merge-resolution
Enable experimental code for handling general merges
(see L<git-debrebase(5)/General merges>).
=head1 SEE ALSO
git-debrebase(1),
-dgit-maint-rebase(7),
+dgit-maint-debrebase(7),
dgit(1),
gitglossary(7)