git-debrebase(5): Rework the description a bit

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

diff --git a/git-debrebase.1.pod b/git-debrebase.1.pod
index cd52c8c18d914b58ce778ffb4a4de56805b549b2..9140702339a470609ac6c5815fb4525731b3e8de 100644 (file)
--- a/git-debrebase.1.pod
+++ b/git-debrebase.1.pod
@@ -20,10 +20,6 @@ For background, theory of operation,
 and definitions of the terms used here,
 see L<git-debrebase(5)>.
 
 and definitions of the terms used here,
 see L<git-debrebase(5)>.
 

-If no operation is specified,
-git-debrebase launders the branch and rebases the Debian delta queue.
-See below.
-

 =head1 PRINCIPAL OPERATIONS
 
 =over
 =head1 PRINCIPAL OPERATIONS
 
 =over


@@ -56,6 +52,8 @@ consuming ffq-prev.
 
 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.
 

+It is a problem if the branch is not laundered.
+

 =item git-debrebase new-upstream-v0 <new-version> [<upstream-details>...]
 
 Rebases the delta queue
 =item git-debrebase new-upstream-v0 <new-version> [<upstream-details>...]
 
 Rebases the delta queue


@@ -65,7 +63,8 @@ Firstly, checks that the proposed rebase seems to make sense:
 It is a problem unless the new upstream(s)
 are fast forward from the previous upstream(s)
 as found in the current breakwater anchor.
 It is a problem unless the new upstream(s)
 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,15 +87,15 @@ 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.

 
 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).
+The new upstream branch (or commit-ish).

 Default is C<upstream>.
 
 It is a problem if the upstream contains a debian/ directory;
 Default is C<upstream>.
 
 It is a problem if the upstream contains a debian/ directory;


@@ -104,10 +103,9 @@ if forced to proceed,
 git-debrebase will disregard the upstream's debian/ and
 take (only) the packaging from the current breakwater.
 
 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 +114,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 +146,16 @@ 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.
+L<git-deborig(1)>,
+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>.
 
 
 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>]
+=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,8 +165,8 @@ 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.
+The upstream commit-ish should correspond to
+the gbp upstream branch, if there is one.

 It is a problem 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.
 It is a problem 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.


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


@@ -243,6 +248,72 @@ 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<problem-id>
+
+Turns problems with id <problem-id> into warnings.
+
+Some troublesome things which git-debrebase encounters
+are B<problem>s.
+(The specific instances are discussed
+in the text for the relvant operation.)
+
+When a problem is detected,
+a message is printed to stderr containing the problem id
+(in the form C<-f<problem-idE<gt>>),
+along with some prose.
+
+If problems are detected, git-debrebase does not continue,
+unless the relevant -f<problem-id> is specified,
+or --force is specified.
+
+=item --force
+
+Turns all problems into warnings.
+See the -f<problem-id> option.
+
+Do not invoke git-debrebase --force in scripts and aliases;
+instead, specify the particular -f<problem-id> for expected problems.
+
+=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,
+regardless of what it's actually like.
+
+(It is a problem for
+git-debrebase new-upstream operations
+if <commit-ish> is the previous anchor to be used,
+because treating an arbitrary commit as an anchor
+means forgoing upstream coherency checks.)
+
+=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.


@@ -250,30 +321,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:
+
+=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
+
+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.

 
 

-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.
 
 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.
 

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

 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.


@@ -300,4 +390,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)