X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=dgit.git;a=blobdiff_plain;f=git-debrebase.1.pod;h=1c3e68128f0e4967e90d1bb9e219b43b075e57a9;hp=556a44223d6673c862d81cff7aa66bf91f82494f;hb=2a7411655b752fddfc8955f2967dbdc504d50451;hpb=7f542a225923b6cb8cfd7d744bdc86293e97fdab diff --git a/git-debrebase.1.pod b/git-debrebase.1.pod index 556a4422..1c3e6812 100644 --- 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 -L. +L. For background, theory of operation, and definitions see L. -You should read this manpage in conjunction with +You should read this manpage in cojnunction with L, which defines many important terms used here. @@ -55,25 +55,52 @@ The options for git-rebase must either start with C<-i>, or be prececded by C<-->, to distinguish them from options for git-debrebase. +=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 +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. -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=] =item git-debrebase stitch [--prose=] 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. -It is a snag (see B<-f>) if the branch is not laundered. +You should consider using B instead, +because that launders the branch too. -=item git-debrebase new-upstream-v0 [...] +=item git-debrebase new-upstream [...] Rebases the delta queue onto a new upstream version. In detail: @@ -115,7 +142,10 @@ The are, optionally, in order: =item The new upstream branch (or commit-ish). -Default is C. +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.) It is a snag if the upstream contains a debian/ directory; if forced to proceed, @@ -169,10 +199,35 @@ L, L, L and L 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. +=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 [] @@ -288,7 +343,7 @@ Turns snag(s) with id into warnings. Some troublesome things which git-debrebase encounters are Bs. (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