changelog: start 9.10

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

diff --git a/git-debrebase.1.pod b/git-debrebase.1.pod
index cbdf292b2812e616248c06cfb8908374680d8c06..d1b4507fab135f63d4dd3ea694c40f1016715c16 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 [-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)>.
 
@@ -531,7 +545,7 @@ This is provided mostly for the benefit of the test suite.
 
 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>).
@@ -619,6 +633,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)