changelog: start 9.14

[dgit.git] / git-debrebase.1.pod

diff --git a/git-debrebase.1.pod b/git-debrebase.1.pod
index af6e3646ad32e04b552931b2249454dbb604ca84..639b07d2e6af4feb4b17a0b9720d6e08a222a774 100644 (file)
--- a/git-debrebase.1.pod
+++ b/git-debrebase.1.pod
@@ -1,21 +1,35 @@
 =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 new-upstream 1.2.3-1 [-i]    # 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)>.
 
@@ -115,11 +129,12 @@ You should consider using B<prepush> or B<conclude> instead.
 =item git-debrebase scrap
 
 Throws away all the work since the branch was last stitched.
-This is done by rewinding you to ffq-prev.
+This is done by resetting you to ffq-prev
+and discarding all working tree changes.
 
 If you are in the middle of a git-rebase, will abort that too.
 
-=item git-debrebase new-upstream <new-version> [<upstream-details>...]
+=item git-debrebase new-upstream <new-version> [<upstream-details>...] [--|-i <git-rebase options...>]
 
 Rebases the delta queue
 onto a new upstream version.  In detail:
@@ -619,6 +634,6 @@ The result is the laundered branch.
 =head1 SEE ALSO
 
 git-debrebase(1),
-dgit-maint-rebase(7),
+dgit-maint-debrebase(7),
 dgit(1),
 gitglossary(7)