X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;ds=sidebyside;f=git-debrebase.1.pod;h=4d4c85a94992b7e83f68d5e8a20212176ee658c6;hb=1e87a7002be126e23144cd2b0a43271e522a75e7;hp=556a44223d6673c862d81cff7aa66bf91f82494f;hpb=7f542a225923b6cb8cfd7d744bdc86293e97fdab;p=dgit.git diff --git a/git-debrebase.1.pod b/git-debrebase.1.pod index 556a4422..4d4c85a9 100644 --- a/git-debrebase.1.pod +++ b/git-debrebase.1.pod @@ -55,23 +55,50 @@ 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, 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 [...] @@ -174,6 +201,33 @@ 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.) + =item git-debrebase convert-from-gbp [] Cnnverts a gbp patches-unapplied branch