diff options
authorSean Whitton <>2019-07-20 13:00:34 +0100
committerIan Jackson <>2019-07-21 16:22:28 +0100
commitc32fe13de2b9eded09a713ea00330131ac719225 (patch)
parent7376ab4e0011581acd76bd90a62073c63026f401 (diff)
git-debrebase(1): Make this manpage a less intimidating entry point
- Nicer short description right in the first section. - Don't use the term 'delta queue' until it's needed. - Don't talk about other manpages so early. - Cater for people who type `man git-debrebase` looking for a barebones tutorial, not (just) a command line reference. - That tutorial should minimise references to dgit, especially since users might want to use git-debpush to upload. Thanks to Sam Hartman for the user feedback which prompted this and Ian Jackson for feedback on the content of "QUICK REFERENCE". Closes: #926656 Signed-off-by: Sean Whitton <> Signed-off-by: Ian Jackson <>
1 files changed, 21 insertions, 7 deletions
diff --git a/git-debrebase.1.pod b/git-debrebase.1.pod
index 6f328dd..d1b4507 100644
--- 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
git-debrebase [<options...>] [-- <git-rebase options...>]
git-debrebase [<options...>] <operation> [<operation options...>
-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)>.
This is the command line reference.
-Please read the tutorial
+There is also a detailed workflow tutorial at
+(on which the above "QUICK REFERENCE" is based).
For background, theory of operation,
and definitions see L<git-debrebase(5)>.