changelog: start 5.5

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

diff --git a/git-debrebase.1.pod b/git-debrebase.1.pod
index 9f82a7c311365bc43b171891d3294cc34be1dfb0..1c3e68128f0e4967e90d1bb9e219b43b075e57a9 100644 (file)
--- a/git-debrebase.1.pod
+++ b/git-debrebase.1.pod
@@ -15,11 +15,11 @@ Debian packages based on upstream source code.
 
 This is the command line reference.
 Please read the tutorial
 
 This is the command line reference.
 Please read the tutorial

-L<dgit-maint-debrebase(5)>.
+L<dgit-maint-debrebase(7)>.

 For background, theory of operation,
 and definitions see L<git-debrebase(5)>.
 
 For background, theory of operation,
 and definitions see L<git-debrebase(5)>.
 

-You should read this manpage in conjunction with
+You should read this manpage in cojnunction with

 L<git-debrebase(5)/TERMINOLOGY>,
 which defines many important terms used here.
 
 L<git-debrebase(5)/TERMINOLOGY>,
 which defines many important terms used here.
 


@@ -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
+
+Analyses the current branch,
+both in terms of its contents,
+and the refs which are relevant to git-debrebase,
+and prints 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,


@@ -87,7 +100,7 @@ If there is no ffq-prev, it is an error, unless --noop-ok.
 You should consider using B<conclude> instead,
 because that launders the branch too.
 
 You should consider using B<conclude> instead,
 because that launders the branch too.
 

-=item git-debrebase new-upstream-v0 <new-version> [<upstream-details>...]
+=item git-debrebase new-upstream <new-version> [<upstream-details>...]

 
 Rebases the delta queue
 onto a new upstream version.  In detail:
 
 Rebases the delta queue
 onto a new upstream version.  In detail:


@@ -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,


@@ -183,10 +199,35 @@ L<git-deborig(1)>,
 L<git-archive(1)>, L<dgit(1)> and
 L<gbp-import-orig(1)> may be able to help.
 
 L<git-archive(1)>, L<dgit(1)> and
 L<gbp-import-orig(1)> may be able to help.
 

-This subcommand has -v0 in its name because we are not yet sure
-that its command line syntax is optimal.
-We may want to introduce an incompatible replacement syntax
-under the name C<new-upstream>.
+=item git-debrebase make-patches [--quiet-would-amend]
+
+Generate patches in debian/patches/
+representing the changes made to upstream files.
+
+It is not normally necessary to run this command explicitly.
+When uploading to Debian,
+dgit and git-debrebase
+will cooperate to regenerate patches as necessary.
+When working with pure git remotes,
+the patches are not needed.
+
+Normally git-debrebase make-patches will
+require a laundered branch.
+(A laundered branch does not contain any patches.)
+But if there are already some patches made by
+git-debrebase make-patches,
+and all that has happened is that more
+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>]
 
 
 =item git-debrebase convert-from-gbp [<upstream-commit-ish>]
 


@@ -302,7 +343,7 @@ Turns snag(s) with id <snag-id> into warnings.
 Some troublesome things which git-debrebase encounters
 are B<snag>s.
 (The specific instances are discussed
 Some troublesome things which git-debrebase encounters
 are B<snag>s.
 (The specific instances are discussed

-in the text for the relvant operation.)
+in the text for the relevant operation.)

 
 When a snag is detected,
 a message is printed to stderr containing the snag id
 
 When a snag is detected,
 a message is printed to stderr containing the snag id