From 6e01ca271e5b8dfdda90b32b225fc53f38ccfc47 Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Sun, 22 Apr 2018 13:27:45 +0100 Subject: git-debrebase: Rename `problem'/`fproblem' to `snag' And add a cross-reference the first time it's mentioned in the manpage. Signed-off-by: Ian Jackson --- git-debrebase.1.pod | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) (limited to 'git-debrebase.1.pod') diff --git a/git-debrebase.1.pod b/git-debrebase.1.pod index a91ad3a..ae095c8 100644 --- a/git-debrebase.1.pod +++ b/git-debrebase.1.pod @@ -55,7 +55,7 @@ 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. +It is a snag (see B<-f>) if the branch is not laundered. =item git-debrebase new-upstream-v0 [...] @@ -63,7 +63,7 @@ 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. And, in the case of a multi-piece upstream @@ -101,7 +101,7 @@ The are, optionally, in order: The new upstream branch (or commit-ish). Default is C. -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. @@ -170,11 +170,11 @@ and dropping the patches from the tree. 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, +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. -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, @@ -265,31 +265,31 @@ docuented under each operation. =over -=item -f +=item -f -Turns problems with id into warnings. +Turns snag(s) with id into warnings. Some troublesome things which git-debrebase encounters -are Bs. +are Bs. (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>), +When a snag is detected, +a message is printed to stderr containing the snag id +(in the form C<-f>), along with some prose. -If problems are detected, git-debrebase does not continue, -unless the relevant -f is specified, +If snags are detected, git-debrebase does not continue, +unless the relevant -f is specified, or --force is specified. =item --force -Turns all problems into warnings. -See the -f option. +Turns all snags into warnings. +See the -f option. Do not invoke git-debrebase --force in scripts and aliases; -instead, specify the particular -f for expected problems. +instead, specify the particular -f for expected snags. =item --noop-ok @@ -309,7 +309,7 @@ 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 problem if is the anchor +it is a snag if is the anchor for the previous upstream version in git-debrebase new-upstream operations. @@ -363,7 +363,7 @@ 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 problem if +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: -- cgit v1.2.3