X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=git-debrebase.1.pod;h=bc1fdd646d6dbf3ccee1334db593f5efbb7d8301;hb=357fe8157dd06aad0e998a37f6cdb3c582ee5be0;hp=6f328dd9b0da015e569c2e27790c43f33c4a1506;hpb=4ebed9cbf04d02915742f95afed7df78cbe6478f;p=dgit.git diff --git a/git-debrebase.1.pod b/git-debrebase.1.pod index 6f328dd9..bc1fdd64 100644 --- a/git-debrebase.1.pod +++ b/git-debrebase.1.pod @@ -1,21 +1,35 @@ =head1 NAME -git-debrebase - delta queue rebase tool for Debian packaging +git-debrebase - tool to maintain series of Debian changes to upstream source =head1 SYNOPSYS git-debrebase [] [-- ] git-debrebase [] [ -=head1 INTRODUCTION +=head1 QUICK REFERENCE -git-debrebase is a tool for representing in git, -and manpulating, -Debian packages based on upstream source code. +These are most of the commands you will regularly need: + + git debrebase -i # edit the patch queue + git debrebase conclude && git push # push to eg salsa + git debrebase conclude && dgit push-source # source-only upload + git debrebase [-i] new-upstream 1.2.3-1 # uses tag, eg "v1.2.3" + dpkg-buildpackage -uc -b # get test debs, at any time + +To add patches, or edit the packaging, just make git commits. +Ignore anything that may appear in debian/patches. +Avoid using "git pull" and "git merge" without "--ff-only". + +git-debrebase has a special branch format, so see +"CONVERTING AN EXISTING PACKAGE" in L. + +=head1 GUIDE TO DOCUMENTATION This is the command line reference. -Please read the tutorial -L. +There is also a detailed workflow tutorial at +L +(on which the above "QUICK REFERENCE" is based). For background, theory of operation, and definitions see L. @@ -115,7 +129,8 @@ You should consider using B or B instead. =item git-debrebase scrap Throws away all the work since the branch was last stitched. -This is done by rewinding you to ffq-prev. +This is done by resetting you to ffq-prev +and discarding all working tree changes. If you are in the middle of a git-rebase, will abort that too.