changelog: Document gdr, and bump to 5.0~

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

diff --git a/git-debrebase.1.pod b/git-debrebase.1.pod
index 5da532029049951d43682eed5671df153e3e75e1..6a98ed2d7bbceb1157c2c86a8b3b1e307bc55ba1 100644 (file)
--- a/git-debrebase.1.pod
+++ b/git-debrebase.1.pod
@@ -55,6 +55,19 @@ The options for git-rebase must either start with C<-i>,
 or be prececded by C<-->,
 to distinguish them from options for git-debrebase.
 
 or be prececded by C<-->,
 to distinguish them from options for git-debrebase.
 

+=item git-debrebase status
+
+Analyise the current branch,
+both in terms of its conents,
+and the refs which are relevant to git-debrebase,
+and print a human-readable summary.
+
+Please do not attempt to parse the output;
+it may be reformatted or reorganised in the future.
+Instead,
+use one of the L<UNDERLYING AND SUPPLEMENTARY OPERATIONS>
+described below.
+

 =item git-debrebase conclude
 
 Finishes a git-debrebase session,
 =item git-debrebase conclude
 
 Finishes a git-debrebase session,


@@ -129,7 +142,10 @@ The <upstream-details> are, optionally, in order:
 =item <upstream-commit-ish>
 
 The new upstream branch (or commit-ish).
 =item <upstream-commit-ish>
 
 The new upstream branch (or commit-ish).

-Default is C<upstream>.
+The default is to look for one of these tags, in this order:
+U vU upstream/U;
+where U is the new upstream version.
+(This is the same algorithm as L<git-deborig(1)>.)

 
 It is a snag if the upstream contains a debian/ directory;
 if forced to proceed,
 
 It is a snag if the upstream contains a debian/ directory;
 if forced to proceed,


@@ -188,7 +204,7 @@ that its command line syntax is optimal.
 We may want to introduce an incompatible replacement syntax
 under the name C<new-upstream>.
 
 We may want to introduce an incompatible replacement syntax
 under the name C<new-upstream>.
 

-=item git-debrebase make-patches
+=item git-debrebase make-patches [--quiet-would-amend]

 
 Generate patches in debian/patches/
 representing the changes made to upstream files.
 
 Generate patches in debian/patches/
 representing the changes made to upstream files.


@@ -209,6 +225,15 @@ and all that has happened is that more
 changes to upstream files have been committed,
 running it again can add the missing patches.
 
 changes to upstream files have been committed,
 running it again can add the missing patches.
 

+If the patches implied by the current branch
+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.)
+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-gbp [<upstream-commit-ish>]
 
 Cnnverts a gbp patches-unapplied branch
 =item git-debrebase convert-from-gbp [<upstream-commit-ish>]
 
 Cnnverts a gbp patches-unapplied branch