chiark / gitweb /
test suite: Honour DGIT_SCHROOT_CHROOT to set the schroot to use for the sbuild tests.
[dgit.git] / git-debrebase.1.pod
index 6a98ed2..273ef47 100644 (file)
@@ -15,11 +15,11 @@ Debian packages based on upstream source code.
 
 This is the command line reference.
 Please read the tutorial
-L<dgit-maint-debrebase(5)>.
+L<dgit-maint-debrebase(7)>.
 For background, theory of operation,
 and definitions see L<git-debrebase(5)>.
 
-You should read this manpage in conjunction with
+You should read this manpage in cojnunction with
 L<git-debrebase(5)/TERMINOLOGY>,
 which defines many important terms used here.
 
@@ -57,10 +57,10 @@ to distinguish them from options for git-debrebase.
 
 =item git-debrebase status
 
-Analyise the current branch,
-both in terms of its conents,
+Analyses the current branch,
+both in terms of its contents,
 and the refs which are relevant to git-debrebase,
-and print a human-readable summary.
+and prints a human-readable summary.
 
 Please do not attempt to parse the output;
 it may be reformatted or reorganised in the future.
@@ -100,7 +100,7 @@ If there is no ffq-prev, it is an error, unless --noop-ok.
 You should consider using B<conclude> instead,
 because that launders the branch too.
 
-=item git-debrebase new-upstream-v0 <new-version> [<upstream-details>...]
+=item git-debrebase new-upstream <new-version> [<upstream-details>...]
 
 Rebases the delta queue
 onto a new upstream version.  In detail:
@@ -135,6 +135,12 @@ If you git-rebase --abort,
 the whole new upstream operation is aborted,
 except for the laundering.
 
+<new-version>
+may be whole new Debian version, including revision,
+or just the upstream part,
+in which case -1 will be appended
+to make the new Debian version.
+
 The <upstream-details> are, optionally, in order:
 
 =over
@@ -199,11 +205,6 @@ 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>.
-
 =item git-debrebase make-patches [--quiet-would-amend]
 
 Generate patches in debian/patches/
@@ -256,9 +257,18 @@ This check exists to detect certain likely user errors,
 but if this situation is true and expected,
 forcing it is fine.
 
+git-debrebase will try to look for the dgit archive view
+of the most recent release,
+and if it finds it will make a pseduomerge so that
+your new git-debrebase view is appropriately fast forward.
+
 The result is a well-formed git-debrebase interchange branch.
 The result is also fast-forward from the gbp branch.
 
+It is a snag if the new branch looks like it will have diverged,
+just as for a laundering/unstitching call to git-debrebase;
+See L</Establish the current branch's ffq-prev>, below.
+
 Note that it is dangerous not to know whether you are
 dealing with a gbp patches-unappled branch containing quilt patches,
 or a git-debrebase interchange branch.
@@ -348,7 +358,7 @@ Turns snag(s) with id <snag-id> into warnings.
 Some troublesome things which git-debrebase encounters
 are B<snag>s.
 (The specific instances are discussed
-in the text for the relvant operation.)
+in the text for the relevant operation.)
 
 When a snag is detected,
 a message is printed to stderr containing the snag id