changelog: start 6.2

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

diff --git a/git-debrebase.1.pod b/git-debrebase.1.pod
index 0127e93d2023f89bea93cc35a90ad3ab88b6ab4b..273ef47dc1c13ee465d59950783a1f495b63763d 100644 (file)
--- a/git-debrebase.1.pod
+++ b/git-debrebase.1.pod
@@ -15,14 +15,13 @@ 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,
 For background, theory of operation,

-and definitions of the terms used here,
-see L<git-debrebase(5)>.
+and definitions see L<git-debrebase(5)>.

 
 

-If no operation is specified,
-git-debrebase launders the branch and rebases the Debian delta queue.
-See below.
+You should read this manpage in cojnunction with
+L<git-debrebase(5)/TERMINOLOGY>,
+which defines many important terms used here.

 
 =head1 PRINCIPAL OPERATIONS
 
 
 =head1 PRINCIPAL OPERATIONS
 


@@ -30,10 +29,13 @@ See below.
 
 =item git-debrebase [-- <git-rebase options...>]
 
 
 =item git-debrebase [-- <git-rebase options...>]
 

+=item git-debrebase [-i <further git-rebase options...>]
+

 Unstitches and launders the branch.
 (See L</UNSTITCHING AND LAUNDERING> below.)
 
 Unstitches and launders the branch.
 (See L</UNSTITCHING AND LAUNDERING> below.)
 

-Then optionally edits the Debian delta queue,
+Then, if any git-rebase options were supplied,
+edits the Debian delta queue,

 using git-rebase, by running
 
     git rebase <git-rebase options> <breakwater-tip>
 using git-rebase, by running
 
     git rebase <git-rebase options> <breakwater-tip>


@@ -49,23 +51,66 @@ If you abort the git-rebase,
 the branch will still have been laundered,
 but everything in the rebase will be undone.
 
 the branch will still have been laundered,
 but everything in the rebase will be undone.
 

+The options for git-rebase must either start with C<-i>,
+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,
+tidying up the branch and making it fast forward again.
+
+Specifically: if the branch is unstitched,
+launders and restitches it,
+making a new pseudomerge.
+Otherwise, it is an error,
+unless --noop-ok.
+
+=item git-debrebase quick
+
+Unconditionally launders and restitches the branch,
+consuming any ffq-prev
+and making a new pseudomerge.
+
+If the branch is already laundered and stitched, does nothing.
+
+=item git-debrebase prepush [--prose=<for commit message>]
+

 =item git-debrebase stitch [--prose=<for commit message>]
 
 =item git-debrebase stitch [--prose=<for commit message>]
 

-Stitch the branch,
+Stitches the branch,

 consuming ffq-prev.
 consuming ffq-prev.

+This is a good command to run before pushing to a git server.

 
 If there is no ffq-prev, it is an error, unless --noop-ok.
 
 
 If there is no ffq-prev, it is an error, unless --noop-ok.
 

-=item git-debrebase new-upstream-v0 <new-version> [<upstream-details>...]
+You should consider using B<conclude> instead,
+because that launders the branch too.
+
+=item git-debrebase new-upstream <new-version> [<upstream-details>...]

 
 Rebases the delta queue
 onto a new upstream version.  In detail:
 
 Firstly, checks that the proposed rebase seems to make sense:
 
 Rebases the delta queue
 onto a new upstream version.  In detail:
 
 Firstly, checks that the proposed rebase seems to make sense:

-It is a problem unless the new upstream(s)
+It is a snag unless the new upstream(s)

 are fast forward from the previous upstream(s)
 as found in the current breakwater anchor.
 are fast forward from the previous upstream(s)
 as found in the current breakwater anchor.

-And, in the case of a multi-piece upstream,
+And, in the case of a multi-piece upstream
+(a multi-component upstream, in dpkg-source terminology),

 if the pieces are not in the same order, with the same names.
 
 If all seems well, unstitches and launders the branch.
 if the pieces are not in the same order, with the same names.
 
 If all seems well, unstitches and launders the branch.


@@ -88,26 +133,34 @@ just like a normal git-rebase.
 
 If you git-rebase --abort,
 the whole new upstream operation is aborted,
 
 If you git-rebase --abort,
 the whole new upstream operation is aborted,

-but the laundering will still have been done.
+except for the laundering.
+
+<new-version>
+may be whole new Debian version, including revision,
+or just the upstream part,
+in which case -1 will be appended
+to make the new Debian version.

 
 The <upstream-details> are, optionally, in order:
 
 =over
 
 
 The <upstream-details> are, optionally, in order:
 
 =over
 

-=item <upstream-commitish>
+=item <upstream-commit-ish>

 
 

-The new upstream branch (or commitish).
-Default is C<upstream>.
+The new upstream branch (or commit-ish).
+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 problem if the upstream contains a debian/ directory;
+It is a snag if the upstream contains a debian/ directory;

 if forced to proceed,
 git-debrebase will disregard the upstream's debian/ and
 take (only) the packaging from the current breakwater.
 
 if forced to proceed,
 git-debrebase will disregard the upstream's debian/ and
 take (only) the packaging from the current breakwater.
 

-=item <piece-name> <piece-upstream-commitish>
+=item <piece-name> <piece-upstream-commit-ish>

 
 Specifies that this is a multi-piece upstream.
 
 Specifies that this is a multi-piece upstream.

-(A multi-component upstream, in dpkg-source terminology.)

 May be repeated.
 
 When such a pair is specified,
 May be repeated.
 
 When such a pair is specified,


@@ -116,7 +169,7 @@ together,
 and then use the result as the combined new upstream.
 
 For each <piece-name>,
 and then use the result as the combined new upstream.
 
 For each <piece-name>,

-the tree of the <piece-upstream-commitish>
+the tree of the <piece-upstream-commit-ish>

 becomes the subdirectory <piece-name>
 in the combined new upstream
 (supplanting any subdirectory that might be there in
 becomes the subdirectory <piece-name>
 in the combined new upstream
 (supplanting any subdirectory that might be there in


@@ -148,14 +201,41 @@ which must be identical to the rev-spec(s)
 passed to git-debrebase.
 git-debrebase does not concern itself with source packages
 so neither helps with this, nor checks it.
 passed to git-debrebase.
 git-debrebase does not concern itself with source packages
 so neither helps with this, nor checks it.

-L<git-archive(1)>, L<dgit(1)> and L<gbp(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 convert-from-gbp [<upstream-commitish>]
+L<git-deborig(1)>,
+L<git-archive(1)>, L<dgit(1)> and
+L<gbp-import-orig(1)> may be able to help.
+
+=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>]

 
 Cnnverts a gbp patches-unapplied branch
 (not a gbp pq patch queue branch)
 
 Cnnverts a gbp patches-unapplied branch
 (not a gbp pq patch queue branch)


@@ -165,21 +245,30 @@ This is done by generating a new anchor merge,
 converting the quilt patches as a delta queue,
 and dropping the patches from the tree.
 
 converting the quilt patches as a delta queue,
 and dropping the patches from the tree.
 

-The upstream commitish should correspond to
-the gbp upstream branch.
-It is a problem if it is not an ancestor of HEAD,
+The upstream commit-ish should correspond to
+the gbp upstream branch, if there is one.
+It is a snag if it is not an ancestor of HEAD,

 or if the history between the upstream and HEAD
 contains commits which make changes to upstream files.
 
 or if the history between the upstream and HEAD
 contains commits which make changes to upstream files.
 

-It is also a problem if the specified upstream
+It is also a snag if the specified upstream

 has a debian/ subdirectory.
 This check exists to detect certain likely user errors,
 but if this situation is true and expected,
 forcing it is fine.
 
 has a debian/ subdirectory.
 This check exists to detect certain likely user errors,
 but if this situation is true and expected,
 forcing it is fine.
 

+git-debrebase will try to look for the dgit archive view
+of the most recent release,
+and if it finds it will make a pseduomerge so that
+your new git-debrebase view is appropriately fast forward.
+

 The result is a well-formed git-debrebase interchange branch.
 The result is also fast-forward from the gbp branch.
 
 The result is a well-formed git-debrebase interchange branch.
 The result is also fast-forward from the gbp branch.
 

+It is a snag if the new branch looks like it will have diverged,
+just as for a laundering/unstitching call to git-debrebase;
+See L</Establish the current branch's ffq-prev>, below.
+

 Note that it is dangerous not to know whether you are
 dealing with a gbp patches-unappled branch containing quilt patches,
 or a git-debrebase interchange branch.
 Note that it is dangerous not to know whether you are
 dealing with a gbp patches-unappled branch containing quilt patches,
 or a git-debrebase interchange branch.


@@ -196,7 +285,12 @@ a dropped patch queue!
 =item git-debrebase breakwater
 
 Prints the breakwater tip commitid.
 =item git-debrebase breakwater
 
 Prints the breakwater tip commitid.

-Fails if your HEAD branch is not laundered.
+If your HEAD branch is not fully laundered,
+prints the tip of the so-far-laundered breakwater.
+
+=item git-debrebase anchor
+
+Prints the breakwater anchor commitid.

 
 =item git-debrebase analyse
 
 
 =item git-debrebase analyse
 


@@ -208,6 +302,16 @@ and commit type and info
 (ie the semantics in the git-debrebase model)
 for each commit.
 
 (ie the semantics in the git-debrebase model)
 for each commit.
 

+=item git-debrebase record-ffq-prev
+
+Establishes the current branch's ffq-prev,
+as discussed in L</UNSTITCHING AND LAUNDERING>,
+but does not launder the branch or move HEAD.
+
+It is an error if the ffq-prev could not be recorded.
+It is also an error if an ffq-prev has already been recorded,
+unless --noop-ok.
+

 =item git-debrebase launder-v0
 
 Launders the branch without recording anything in ffq-prev.
 =item git-debrebase launder-v0
 
 Launders the branch without recording anything in ffq-prev.


@@ -233,6 +337,74 @@ or you will drop all the patches!
 
 =back
 
 
 =back
 

+=head1 OPTIONS
+
+This section documents the general options
+to git-debrebase
+(ie, the ones which immediately follow
+git-debrebase
+or
+git debrebase
+on the command line).
+Individual operations may have their own options which are
+docuented under each operation.
+
+=over
+
+=item -f<snag-id>
+
+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
+in the text for the relevant operation.)
+
+When a snag is detected,
+a message is printed to stderr containing the snag id
+(in the form C<-f<snag-idE<gt>>),
+along with some prose.
+
+If snags are detected, git-debrebase does not continue,
+unless the relevant -f<snag-id> is specified,
+or --force is specified.
+
+=item --force
+
+Turns all snags into warnings.
+See the -f<snag-id> option.
+
+Do not invoke git-debrebase --force in scripts and aliases;
+instead, specify the particular -f<snag-id> for expected snags.
+
+=item --noop-ok
+
+Suppresses the error in
+some situations where git-debrebase does nothing,
+because there is nothing to do.
+
+The specific instances are discussed
+in the text for the relvant operation.
+
+=item --anchor=<commit-ish>
+
+Treats <commit-ish> as an anchor.
+This overrides the usual logic which automatically classifies
+commits as anchors, pseudomerges, delta queue commits, etc.
+
+It also disables some coherency checks
+which depend on metadata extracted from its commit message,
+so
+it is a snag if <commit-ish> is the anchor
+for the previous upstream version in
+git-debrebase new-upstream operations.
+
+=item -D
+
+Requests (more) debugging.  May be repeated.
+
+=back
+

 =head1 UNSTITCHING AND LAUNDERING
 
 Several operations unstitch and launder the branch first.
 =head1 UNSTITCHING AND LAUNDERING
 
 Several operations unstitch and launder the branch first.


@@ -240,30 +412,49 @@ In detail this means:
 
 =head2 Establish the current branch's ffq-prev
 
 
 =head2 Establish the current branch's ffq-prev
 

-If it is not yet recorded,
+If ffq-prev is not yet recorded,

 git-debrebase checks that the current branch is ahead of relevant
 remote tracking branches.
 git-debrebase checks that the current branch is ahead of relevant
 remote tracking branches.

+The relevant branches depend on
+the current branch (and its
+git configuration)
+and are as follows:

 
 

-The remote tracking branches checked by default are
-obtained from the git config.
-In each case it is a problem if
-the local HEAD is behind the checked remote,
-or if local HEAD has diverged from it.
-All the checks are done locally using the remote tracking refs:
-git-debrebase does not fetch anything from anywhere.
+=over
+
+=item
+
+The branch that git would merge from
+(remote.<branch>.merge, remote.<branch>.remote);
+
+=item
+
+The branch git would push to, if different
+(remote.<branch>.pushRemote etc.);
+
+=item
+
+For local dgit suite branches,
+the corresponding tracking remote;
+
+=item

 
 

-git-debrebase checks the branch that git would merge from
-(remote.<branch>.merge, remote.<branch>.remote)
-and the branch git would push to
-(remote.<branch>.pushRemote etc.).
-For local dgit suite branches
-it checks the corresponding tracking remote.
-If you are on C<master>, it checks remotes/dgit/dgit/sid.
-The resulting ref names to check are filtered through
+If you are on C<master>,
+remotes/dgit/dgit/sid.
+
+=back
+
+The apparently relevant ref names to check are filtered through

 branch.<branch>.ffq-ffrefs,
 which is a semicolon-separated list of glob patterns,
 each optionally preceded by !; first match wins.
 
 branch.<branch>.ffq-ffrefs,
 which is a semicolon-separated list of glob patterns,
 each optionally preceded by !; first match wins.
 

+In each case it is a snag if
+the local HEAD is behind the checked remote,
+or if local HEAD has diverged from it.
+All the checks are done locally using the remote tracking refs:
+git-debrebase does not fetch anything from anywhere.
+

 If these checks pass,
 or are forced,
 git-debrebse then records the current tip as ffq-prev.
 If these checks pass,
 or are forced,
 git-debrebse then records the current tip as ffq-prev.


@@ -290,4 +481,5 @@ The result is the laundered branch.
 
 git-debrebase(1),
 dgit-maint-rebase(7),
 
 git-debrebase(1),
 dgit-maint-rebase(7),

-dgit(1)
+dgit(1),
+gitglossary(7)