chiark / gitweb /
git-debrebase(1): document options
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Mon, 19 Feb 2018 01:38:37 +0000 (01:38 +0000)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Sat, 16 Jun 2018 15:07:00 +0000 (16:07 +0100)
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
git-debrebase.1.pod

index cd52c8c..9ddf939 100644 (file)
@@ -243,6 +243,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.