git-debrebase: Rework keycommits out of breakwater_of

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

diff --git a/git-debrebase.1.pod b/git-debrebase.1.pod
index 0127e93d2023f89bea93cc35a90ad3ab88b6ab4b..ba603ba577091b6a5ac84b1637fd2c0a8fd9fb3c 100644 (file)
--- a/git-debrebase.1.pod
+++ b/git-debrebase.1.pod
@@ -56,6 +56,8 @@ consuming ffq-prev.
 
 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
@@ -196,7 +198,8 @@ a dropped patch queue!
 =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 analyse
 
@@ -208,6 +211,16 @@ and commit type and info
 (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.
@@ -233,6 +246,68 @@ or you will drop all the patches!
 
 =back
 
+=head1 OPTIONS
+
+This section documents the general options
+to git-debrebase
+(ie, the ones which follow git-debrebase).
+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=<commitish>
+
+Treats <commitish> as an anchor,
+regardless of what it's actually like.
+
+(It is a problem for
+git-debrebase new-upstream operations
+if <commitish> 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.