dgit: Refactor %internal_object_save from $dgit_view_save

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

diff --git a/git-debrebase.1.pod b/git-debrebase.1.pod
index 556a44223d6673c862d81cff7aa66bf91f82494f..db22fa5d5023baad3e6ec5198de6913e53ce8eba 100644 (file)
--- a/git-debrebase.1.pod
+++ b/git-debrebase.1.pod
@@ -15,11 +15,11 @@ Debian packages based on upstream source code.
 
 This is the command line reference.
 Please read the tutorial
 
 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)>.
 
 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.
 
 L<git-debrebase(5)/TERMINOLOGY>,
 which defines many important terms used here.
 


@@ -55,25 +55,58 @@ The options for git-rebase must either start with C<-i>,
 or be prececded by C<-->,
 to distinguish them from options for git-debrebase.
 
 or be prececded by C<-->,
 to distinguish them from options for git-debrebase.
 

+It is hazardous to use plain git-rebase on a git-debrebase branch,
+because git-rebase has a tendency to start the rebase
+too far back in history,
+and then drop important commits.
+Soo L<git-debrebase(5)/ILLEGAL OPERATIONS>
+
+=item git-debrebase status
+
+Analyses the current branch,
+both in terms of its contents,
+and the refs which are relevant to git-debrebase,
+and prints a human-readable summary.
+
+Please do not attempt to parse the output;
+it may be reformatted or reorganised in the future.
+Instead,
+use one of the L<UNDERLYING AND SUPPLEMENTARY OPERATIONS>
+described below.
+
+=item git-debrebase conclude
+
+Finishes a git-debrebase session,
+tidying up the branch and making it fast forward again.
+
+Specifically: if the branch is unstitched,
+launders and restitches it,
+making a new pseudomerge.
+Otherwise, it is an error,
+unless --noop-ok.
+

 =item git-debrebase quick
 
 Unconditionally launders and restitches the branch,
 consuming any ffq-prev
 and making a new pseudomerge.
 
 =item git-debrebase quick
 
 Unconditionally launders and restitches the branch,
 consuming any ffq-prev
 and making a new pseudomerge.
 

-If the branch is already laundered and stitched, it is an error,
-unless --noop-ok.
+If the branch is already laundered and stitched, does nothing.
+
+=item git-debrebase prepush [--prose=<for commit message>]

 
 =item git-debrebase stitch [--prose=<for commit message>]
 
 Stitches the branch,
 consuming ffq-prev.
 
 =item git-debrebase stitch [--prose=<for commit message>]
 
 Stitches the branch,
 consuming ffq-prev.

+This is a good command to run before pushing to a git server.

 
 If there is no ffq-prev, it is an error, unless --noop-ok.
 
 
 If there is no ffq-prev, it is an error, unless --noop-ok.
 

-It is a snag (see B<-f>) if the branch is not laundered.
+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:
 
 Rebases the delta queue
 onto a new upstream version.  In detail:


@@ -108,6 +141,12 @@ If you git-rebase --abort,
 the whole new upstream operation is aborted,
 except for the laundering.
 
 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
 The <upstream-details> are, optionally, in order:
 
 =over


@@ -115,7 +154,10 @@ The <upstream-details> are, optionally, in order:
 =item <upstream-commit-ish>
 
 The new upstream branch (or commit-ish).
 =item <upstream-commit-ish>
 
 The new upstream branch (or commit-ish).

-Default is C<upstream>.
+The default is to look for one of these tags, in this order:
+U vU upstream/U;
+where U is the new upstream version.
+(This is the same algorithm as L<git-deborig(1)>.)

 
 It is a snag if the upstream contains a debian/ directory;
 if forced to proceed,
 
 It is a snag if the upstream contains a debian/ directory;
 if forced to proceed,


@@ -169,10 +211,35 @@ L<git-deborig(1)>,
 L<git-archive(1)>, L<dgit(1)> and
 L<gbp-import-orig(1)> may be able to help.
 
 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/
+representing the changes made to upstream files.
+
+It is not normally necessary to run this command explicitly.
+When uploading to Debian,
+dgit and git-debrebase
+will cooperate to regenerate patches as necessary.
+When working with pure git remotes,
+the patches are not needed.
+
+Normally git-debrebase make-patches will
+require a laundered branch.
+(A laundered branch does not contain any patches.)
+But if there are already some patches made by
+git-debrebase make-patches,
+and all that has happened is that more
+changes to upstream files have been committed,
+running it again can add the missing patches.
+
+If the patches implied by the current branch
+are not a simple superset of those already in debian/patches,
+make-patches will fail with exit status 7,
+and an error message.
+(The message can be suppress with --quiet-would-amend.)
+If the problem is simply that
+the existing patches were not made by git-debrebase,
+using dgit quilt-fixup instead should succeed.

 
 =item git-debrebase convert-from-gbp [<upstream-commit-ish>]
 
 
 =item git-debrebase convert-from-gbp [<upstream-commit-ish>]
 


@@ -189,6 +256,8 @@ the gbp upstream branch, if there is one.
 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 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.

+If it is not specified,
+the same algorithm is used as for git-debrebase new-upstream.

 
 It is also a snag if the specified upstream
 has a debian/ subdirectory.
 
 It is also a snag if the specified upstream
 has a debian/ subdirectory.


@@ -196,11 +265,20 @@ This check exists to detect certain likely user errors,
 but if this situation is true and expected,
 forcing it is fine.
 
 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.
 
 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
 Note that it is dangerous not to know whether you are

-dealing with a gbp patches-unappled branch containing quilt patches,
+dealing with a gbp patches-unapplied branch containing quilt patches,

 or a git-debrebase interchange branch.
 At worst,
 using the wrong tool for the branch format might result in
 or a git-debrebase interchange branch.
 At worst,
 using the wrong tool for the branch format might result in


@@ -288,7 +366,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
 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
 
 When a snag is detected,
 a message is printed to stderr containing the snag id