X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=git-debrebase.1.pod;h=27b5c9337596e0235957bfbda32f5ad36a4edf07;hb=36b438215ab570e57de03a4902a5cc3363951cb9;hp=ae095c8c194097e794ebd0b441ac6857a9d84df9;hpb=6e01ca271e5b8dfdda90b32b225fc53f38ccfc47;p=dgit.git diff --git a/git-debrebase.1.pod b/git-debrebase.1.pod index ae095c8c..27b5c933 100644 --- a/git-debrebase.1.pod +++ b/git-debrebase.1.pod @@ -29,10 +29,13 @@ which defines many important terms used here. =item git-debrebase [-- ] +=item git-debrebase [-i ] + Unstitches and launders the branch. (See L below.) -Then optionally edits the Debian delta queue, +Then, if any git-rebase options were supplied, +edits the Debian delta queue, using git-rebase, by running git rebase @@ -48,14 +51,54 @@ If you abort the git-rebase, the branch will still have been laundered, but everything in the rebase will be undone. +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 + +Analyise the current branch, +both in terms of its conents, +and the refs which are relevant to git-debrebase, +and print 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, does nothing. + +=item git-debrebase prepush [--prose=] + =item git-debrebase stitch [--prose=] -Stitch the branch, +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 [...] @@ -158,6 +201,27 @@ 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 + +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. + =item git-debrebase convert-from-gbp [] Cnnverts a gbp patches-unapplied branch