diff options
author | Ian Jackson <ijackson@chiark.greenend.org.uk> | 2018-02-19 01:38:37 +0000 |
---|---|---|
committer | Ian Jackson <ijackson@chiark.greenend.org.uk> | 2018-06-16 16:07:00 +0100 |
commit | 92c9546d19a2e4edf3de98b7487d582237a19ca0 (patch) | |
tree | 6147dec9b93656b7997430b18840208847af1c2f | |
parent | 590e761ded0af7b6ceca855190820b7c15d85ab8 (diff) |
git-debrebase(1): document options
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
-rw-r--r-- | git-debrebase.1.pod | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/git-debrebase.1.pod b/git-debrebase.1.pod index cd52c8c..9ddf939 100644 --- a/git-debrebase.1.pod +++ b/git-debrebase.1.pod @@ -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. |