git-debrebase: Break out record_gdrlast

[dgit.git] / dgit.1

diff --git a/dgit.1 b/dgit.1
index 2705d624f419e8f86a7af5f5438653224cb479a2..4aea52f0b55562d24358c9fab7a9760c83e5366b 100644 (file)
--- a/dgit.1
+++ b/dgit.1
@@ -14,7 +14,11 @@ dgit \- git integration with the Debian archive
 .br
 .B dgit
 [\fIdgit\-opts\fP] \fBbuild\fP|\fBsbuild\fP|\fBbuild-source\fP
 .br
 .B dgit
 [\fIdgit\-opts\fP] \fBbuild\fP|\fBsbuild\fP|\fBbuild-source\fP

-[\fIbuild\-opts\fp]
+[\fIbuild\-opts\fP]
+.br
+.B dgit
+[\fIdgit\-opts\fP] \fBpbuilder\fP|\fBcowbuilder\fP
+[\fIdebbuildopts\fP]

 .br
 .B dgit
 [\fIdgit\-opts\fP] \fBpush\fP|\fBpush-source\fP [\fIdgit\-opts\fP]
 .br
 .B dgit
 [\fIdgit\-opts\fP] \fBpush\fP|\fBpush-source\fP [\fIdgit\-opts\fP]


@@ -39,12 +43,14 @@ This is the command line reference.
 Please read the tutorial(s):
 .TS
 lb l.
 Please read the tutorial(s):
 .TS
 lb l.

-dgit-user(7)   for users: editing, building and sharing packages
-dgit-nmu-simple(7)     for DDs: doing a straightforward NMU
+dgit-user(7)   for users: edit, build and share packages
+dgit-nmu-simple(7)     for DDs: do a straightforward NMU

 dgit-maint-native(7)   for maintainers of Debian-native packages
 dgit-maint-native(7)   for maintainers of Debian-native packages

-dgit-maint-merge(7)    for maintainers who want a pure git workflow
+dgit-maint-debrebase(7)        for maintainers: a pure-git rebasish workflow
+dgit-maint-merge(7)    for maintainers: a pure-git merging workflow

 dgit-maint-gbp(7)      for maintainers already using git-buildpackage
 dgit-sponsorship(7)    for sponsors and sponsored contributors
 dgit-maint-gbp(7)      for maintainers already using git-buildpackage
 dgit-sponsorship(7)    for sponsors and sponsored contributors

+dgit-downstream-dsc(7) setting up dgit push for a new distro

 .TE
 .LP
 See \fBdgit(7)\fP for detailed information about the data
 .TE
 .LP
 See \fBdgit(7)\fP for detailed information about the data


@@ -87,6 +93,7 @@ For your convenience, the
 remote will be set up from the package's Vcs-Git field, if there is
 one - but note that in the general case the history found there may be
 different to or even disjoint from dgit's view.
 remote will be set up from the package's Vcs-Git field, if there is
 one - but note that in the general case the history found there may be
 different to or even disjoint from dgit's view.

+(See also dgit update-vcs-git.)

 .TP
 \fBdgit fetch\fR [\fIsuite\fP]
 Consults the archive and git-repos to update the git view of
 .TP
 \fBdgit fetch\fR [\fIsuite\fP]
 Consults the archive and git-repos to update the git view of


@@ -107,6 +114,27 @@ branch
 .BI remotes/dgit/dgit/ suite
 into the current branch.
 .TP
 .BI remotes/dgit/dgit/ suite
 into the current branch.
 .TP

+\fBdgit checkout\fR \fIsuite\fR
+Checks out the local branch
+.BR dgit/ \fIsuite\fR.
+
+If the branch does not exist,
+dgit checkout creates it,
+and sets it up the same way as dgit clone would.
+In that case, if
+the archive remote tracking branch does not exist,
+dgit checkout will do a dgit fetch first.
+
+NB: dgit checkout will only do a fetch if it has to.
+If you already have the suite branch,
+and want to merge your branch with updates from the archive,
+use dgit pull.
+
+dgit checkout will normally need to aceess the archive server,
+to canonicalise the provided suite name.
+The exception is if you specify the canonical name,
+and the branch (or tracking branch) already exists.
+.TP

 \fBdgit build\fR ...
 Runs
 .B dpkg-buildpackage
 \fBdgit build\fR ...
 Runs
 .B dpkg-buildpackage


@@ -117,6 +145,10 @@ that the generated source package corresponds to the relevant git
 commit.
 
 Tagging, signing and actually uploading should be left to dgit push.
 commit.
 
 Tagging, signing and actually uploading should be left to dgit push.

+
+dgit's build operations access the the network,
+to get the -v option right.
+See -v, below.

 .TP
 \fBdgit build-source\fR ...
 Builds the source package, and a changes file for a prospective
 .TP
 \fBdgit build-source\fR ...
 Builds the source package, and a changes file for a prospective


@@ -134,6 +166,20 @@ push-source, or dgit push.
 Cleans the current working tree (according to the --clean= option in
 force).
 .TP
 Cleans the current working tree (according to the --clean= option in
 force).
 .TP

+\fBdgit update-vcs-git\fR [\fIsuite\fP|\fB.\fR] [\fB--\fR] [\fIgit fetch options\fR]
+.TQ
+\fBdgit update-vcs-git\fR [\fIsuite|\fP\fB.\fR] \fB-\fR
+Sets up, or updates the url of, the vcs-git remote, and
+(unless \fB-\fR was specified)
+runs git fetch on it.
+
+By default, the Vcs-Git field of the .dsc from Debian sid is used,
+as that is probably most up to date.
+Another suite may be specified, or
+.B .
+to indicate that the Vcs-Git of the cwd's debian/control should
+be used instead.
+.TP

 .B dgit help
 Print a usage summary.
 .TP
 .B dgit help
 Print a usage summary.
 .TP


@@ -152,6 +198,35 @@ You probably want to pass -A, to request those.
 .IP
 Tagging, signing and actually uploading should be left to dgit push.
 .TP
 .IP
 Tagging, signing and actually uploading should be left to dgit push.
 .TP

+\fBdgit pbuilder\fR [\fIdebbuildopts\fP]
+Constructs the source package, uses
+.B  pbuilder
+to do a binary build, and uses mergechanges to merge the source and
+binary changes files.
+The output is left in
+.IR package \fB_\fR version \fB_multi.changes\fR.
+
+You should ensure that your dgit --build-products-dir setting matches
+your pbuilder --buildresult.
+
+The \fIdebbuildopts\fP are passed to pbuilder using its --debbuildopts
+option.  If you want to pass other options to pbuilder, use the
+\fB--pbuilder:\fR dgit option as described below
+(remember that dgit options should appear between \fBdgit\fR and
+\fBpbuilder\fR).
+
+You should ensure that in your pbuilderrc you do
+.B not
+have the setting
+.B SOURCE_ONLY_CHANGES=yes
+as this may cause trouble.
+.TP
+\fBdgit cowbuilder\fR [\fIdebbuildopts\fP]
+Like \fBdgit pbuilder\fR, but uses
+.B cowbuilder
+instead of
+.B pbuilder.
+.TP

 \fBdgit gbp-build\fR ...
 Runs
 .B git-buildpackage
 \fBdgit gbp-build\fR ...
 Runs
 .B git-buildpackage


@@ -185,6 +260,11 @@ archive.
 dgit push always uses the package, suite and version specified in the
 debian/changelog and the .dsc, which must agree.  If the command line
 specifies a suite then that must match too.
 dgit push always uses the package, suite and version specified in the
 debian/changelog and the .dsc, which must agree.  If the command line
 specifies a suite then that must match too.

+
+When used on a git-debrebase branch,
+dgit calls git-debrebase
+to prepare the branch
+for source package upload and push.

 .TP
 \fBdgit push-source\fR [\fIsuite\fP]
 Without \fB-C\fR, builds a source package and dgit pushes it.  Saying
 .TP
 \fBdgit push-source\fR [\fIsuite\fP]
 Without \fB-C\fR, builds a source package and dgit pushes it.  Saying


@@ -236,6 +316,11 @@ and
 (but only does each thing if dgit is configured to do it automatically).
 You can use these in any git repository, not just ones used with
 the other dgit operations.
 (but only does each thing if dgit is configured to do it automatically).
 You can use these in any git repository, not just ones used with
 the other dgit operations.

+Does
+.B not
+run
+.B update-vcs-git
+(as that requires Debian packaging information).

 .TP
 .B dgit setup-useremail
 Set the working tree's user.name and user.email from the
 .TP
 .B dgit setup-useremail
 Set the working tree's user.name and user.email from the


@@ -262,10 +347,19 @@ For why, see
 in
 .BR dgit(7) .
 
 in
 .BR dgit(7) .
 

+If there is an existing macro attribute line
+.B [attr]dgit-defuse-attrs
+in .git/info/attributes,
+but it is insufficient,
+because it was made by an earlier version of dgit
+and git has since introduced new transforming attributes,
+modifies the macro to disable the newer transformations.
+

 (If there is already a macro attribute line
 .B [attr]dgit-defuse-attrs
 in .git/info/attributes
 (If there is already a macro attribute line
 .B [attr]dgit-defuse-attrs
 in .git/info/attributes

-(whatever its effects),
+which does what dgit requires
+(whatever files it effects),

 this operation does nothing further.
 This fact can be used to defeat or partially defeat
 dgit setup-gitattributes
 this operation does nothing further.
 This fact can be used to defeat or partially defeat
 dgit setup-gitattributes


@@ -286,6 +380,20 @@ new quilt patch.  dgit cannot convert nontrivial merges, or certain
 other kinds of more exotic history.  If dgit can't find a suitable
 linearisation of your history, by default it will fail, but you can
 ask it to generate a single squashed patch instead.
 other kinds of more exotic history.  If dgit can't find a suitable
 linearisation of your history, by default it will fail, but you can
 ask it to generate a single squashed patch instead.

+
+When used with a git-debrebase branch,
+dgit will ask git-debrebase to prepare patches.
+However,
+dgit can make patches in some situations where git-debrebase fails,
+so dgit quilt-fixup can be useful in its own right.
+To always use dgit's own patch generator
+instead of git-debrebase make-patches,
+pass --git-debrebase=true to dgit.
+
+See
+.B FORMAT 3.0 (QUILT)
+in
+.BR dgit(7) .

 .TP
 \fBdgit import-dsc\fR [\fIsub-options\fR] \fI../path/to/.dsc\fR [\fB+\fR|\fB..\fR]branch
 Import a Debian-format source package,
 .TP
 \fBdgit import-dsc\fR [\fIsub-options\fR] \fI../path/to/.dsc\fR [\fB+\fR|\fB..\fR]branch
 Import a Debian-format source package,


@@ -363,6 +471,26 @@ to cause it to exclude exactly the .git diredcory
 and nothing else.
 The separate arguments are unquoted, separated by spaces,
 and do not contain spaces.
 and nothing else.
 The separate arguments are unquoted, separated by spaces,
 and do not contain spaces.

+.TP
+.B dgit print-unapplied-treeish
+Constructs a tree-ish approximating the patches-unapplied state
+of your 3.0 (quilt) package,
+and prints the git object name to stdout.
+This requires appropriate .orig tarballs.
+This tree object is identical to your .origs
+as regards upstream files.
+The contents of the debian subdirectory is not interesting
+and should not be inspected;
+except that debian/patches will be identical to your HEAD.
+
+To make this operate off-line,
+the access configuration key
+which is used to determine the build-products-dir
+is the uncanonicalised version of the suite name from the changelog,
+or (of course) dgit.default.build-products-dir.
+See ACCESS CONFIGURATION, below.
+
+This function is primarily provided for the benefit of git-debrebase.

 .SH OPTIONS
 .TP
 .BR --dry-run " | " -n
 .SH OPTIONS
 .TP
 .BR --dry-run " | " -n


@@ -454,35 +582,61 @@ refuse to push.  It may (for Debian, will) be unable to access the git
 history for any packages which have been newly pushed and have not yet
 been published.
 .TP
 history for any packages which have been newly pushed and have not yet
 been published.
 .TP

-.BR --ignore-dirty
-Do not complain if the working tree does not match your git HEAD.
+.BR --include-dirty
+Do not complain if the working tree does not match your git HEAD,
+and when building,
+include the changes from your working tree.

 This can be useful with build, if you plan to commit later.  (dgit
 push will still ensure that the .dsc you upload and the git tree
 you push are identical, so this option won't make broken pushes.)
 .TP
 This can be useful with build, if you plan to commit later.  (dgit
 push will still ensure that the .dsc you upload and the git tree
 you push are identical, so this option won't make broken pushes.)
 .TP

+.BR --ignore-dirty
+Deprecated alias for --include-dirty.
+.TP

 .BR --overwrite [=\fIprevious-version\fR]
 .BR --overwrite [=\fIprevious-version\fR]

-Declare that even though your git branch is not a descendant
+Declare that your HEAD really does contain
+all the (wanted) changes
+from all versions listed in its changelog;
+or, all (wanted) changes from
+.IR previous-version .
+This promise is needed when
+your git branch is not a descendant

 of the version in the archive
 of the version in the archive

-according to the revision history,
-it really does contain
-all the (wanted) changes from that version.
+according to the git revision history.
+
+It is safer not to specify
+.IR previous-version ,
+and usually it's not needed.
+Just say
+.BR --overwrite ,
+unless you know what you are doing.

 
 This option is useful if you are the maintainer, and you have
 incorporated NMU changes into your own git workflow in a way that
 doesn't make your branch a fast forward from the NMU.
 
 
 This option is useful if you are the maintainer, and you have
 incorporated NMU changes into your own git workflow in a way that
 doesn't make your branch a fast forward from the NMU.
 

-.I previous-version
-ought to be the version currently in the archive.  If
+This option is also usually necessary
+the first time a package is pushed with dgit push
+to a particular suite.
+See
+.BR dgit-maint- \fI*\fR (7) .
+
+If

 .I previous-version
 is not
 specified, dgit will check that the version in the archive is
 mentioned in your debian/changelog.
 (This will avoid losing
 .I previous-version
 is not
 specified, dgit will check that the version in the archive is
 mentioned in your debian/changelog.
 (This will avoid losing

-changes unless someone committed to git a finalised changelog
+changes, even with
+.BR --overwrite ,
+unless someone committed to git a finalised changelog

 entry, and then made later changes to that version.)
 entry, and then made later changes to that version.)

+If
+.IR previous-version
+is specified, it ought to be the version currently in the archive.

 
 dgit push --overwrite
 
 dgit push --overwrite

-will make a
+will, if necessary, make a

 pseudo-merge (that is, something that looks like the result
 of git merge -s ours) to stitch the archive's version into your own
 git history, so that your push is a fast forward from the archive.
 pseudo-merge (that is, something that looks like the result
 of git merge -s ours) to stitch the archive's version into your own
 git history, so that your push is a fast forward from the archive.


@@ -534,7 +688,7 @@ Also,
 it can mean that
 dgit fails to find necessary git commits.
 .TP
 it can mean that
 dgit fails to find necessary git commits.
 .TP

-.BR --dgit-view-save= \fIbranch\fR|\fIref\fR
+.BR --save-dgit-view= \fIbranch\fR|\fIref\fR

 Specifies that when a split view quilt mode is in operation,
 and dgit calculates
 (or looks up in its cache)
 Specifies that when a split view quilt mode is in operation,
 and dgit calculates
 (or looks up in its cache)


@@ -554,6 +708,10 @@ And it is only effective with
 If ref does not start with refs/
 it is taken to to be a branch -
 i.e. refs/heads/ is prepended.
 If ref does not start with refs/
 it is taken to to be a branch -
 i.e. refs/heads/ is prepended.

+
+.B --dgit-view-save
+is a deprecated alias for
+--save-dgit-view.

 .TP
 .BI --deliberately- something
 Declare that you are deliberately doing
 .TP
 .BI --deliberately- something
 Declare that you are deliberately doing


@@ -750,9 +908,20 @@ Note that \fBdgit push-source\fR will always find the right .changes,
 regardless of this option.
 .TP
 .BI --build-products-dir= directory
 regardless of this option.
 .TP
 .BI --build-products-dir= directory

-Specifies where to find the built files to be uploaded.
-By default, dgit looks in the parent directory
+Specifies where to find and create tarballs, binry packages,
+source packages, .changes files, and so on.
+
+By default, dgit uses the parent directory

 .RB ( .. ).
 .RB ( .. ).

+
+Changing this setting may necessitate
+moving .orig tarballs to the new directory,
+so it is probably best to
+use the
+.BI dgit.default.build-products-dir
+configuration setting
+(see CONFIGURATION, below)
+which this command line option overrides).

 .TP
 .BI --no-rm-on-error
 Do not delete the destination directory if clone fails.
 .TP
 .BI --no-rm-on-error
 Do not delete the destination directory if clone fails.


@@ -823,6 +992,8 @@ Specifies a single additional option to pass to
 .BR dpkg-buildpackage ,
 .BR dpkg-genchanges ,
 .BR sbuild ,
 .BR dpkg-buildpackage ,
 .BR dpkg-genchanges ,
 .BR sbuild ,

+.BR pbuilder ,
+.BR cowbuilder ,

 .BR ssh ,
 .BR dgit ,
 .BR git-debrebase ,
 .BR ssh ,
 .BR dgit ,
 .BR git-debrebase ,


@@ -870,6 +1041,8 @@ Specifies alternative programs to use instead of
 .BR dpkg-buildpackage ,
 .BR dpkg-genchanges ,
 .BR sbuild ,
 .BR dpkg-buildpackage ,
 .BR dpkg-genchanges ,
 .BR sbuild ,

+.BR pbuilder ,
+.BR cowbuilder ,

 .BR gpg ,
 .BR ssh ,
 .BR dgit ,
 .BR gpg ,
 .BR ssh ,
 .BR dgit ,


@@ -908,6 +1081,14 @@ In both cases,
 unusually, the specified value is split on whitespace
 to produce a command and possibly some options and/or arguments.
 
 unusually, the specified value is split on whitespace
 to produce a command and possibly some options and/or arguments.
 

+For pbuilder and cowbuilder, the defaults are
+.BR "sudo -E pbuilder"
+and
+.BR "sudo -E cowbuilder"
+respectively.
+Like with gbp-build and gbp pq,
+the specified value is split on whitespace.
+

 For
 .BR ssh ,
 the default value is taken from the
 For
 .BR ssh ,
 the default value is taken from the


@@ -962,6 +1143,17 @@ The result is a fresh import,
 discarding the git history
 that the person who pushed that .dsc was working with.
 .TP
 discarding the git history
 that the person who pushed that .dsc was working with.
 .TP

+.B --force-uploading-binaries
+Carry on and
+upload binaries
+even though dgit thinks your distro does not permit that.
+.TP
+.B --force-uploading-source-only
+Carry on and do a source-only upload,
+without any binaries,
+even though dgit thinks your distro does not permit that,
+or does not permit that in this situation.
+.TP

 .B --force-unrepresentable
 Carry on even if
 dgit thinks that your git tree contains changes
 .B --force-unrepresentable
 Carry on even if
 dgit thinks that your git tree contains changes


@@ -996,6 +1188,12 @@ on the dgit command line.
 .LP
 Settings likely to be useful for an end user include:
 .TP
 .LP
 Settings likely to be useful for an end user include:
 .TP

+.BI dgit.default.build-products-dir
+Specifies where to find the built files to be uploaded,
+when --build-products-dir is not specified.  The default is
+the parent directory
+.RB ( .. ).
+.TP

 .BR dgit-suite. \fIsuite\fR .distro " \fIdistro\fR"
 Specifies the distro for a suite.  dgit keys off the suite name (which
 appears in changelogs etc.), and uses that to determine the distro
 .BR dgit-suite. \fIsuite\fR .distro " \fIdistro\fR"
 Specifies the distro for a suite.  dgit keys off the suite name (which
 appears in changelogs etc.), and uses that to determine the distro


@@ -1138,6 +1336,8 @@ or when pushing and
 .TP
 .BI dgit-distro. distro .rewrite-map-enable
 .TP
 .TP
 .BI dgit-distro. distro .rewrite-map-enable
 .TP

+.BR dgit-distro. \fIdistro\fR .source-only-uploads " " ok | always | never | not-wholly-new
+.TP

 .BI dgit.default.old-dsc-distro
 .TP
 .BI dgit.dsc-url-proto-ok. protocol
 .BI dgit.default.old-dsc-distro
 .TP
 .BI dgit.dsc-url-proto-ok. protocol


@@ -1145,6 +1345,8 @@ or when pushing and
 .BI dgit.dsc-url-proto-ok.bad-syntax
 .TP
 .BI dgit.default.dsc-url-proto-ok
 .BI dgit.dsc-url-proto-ok.bad-syntax
 .TP
 .BI dgit.default.dsc-url-proto-ok

+.TP
+.BR dgit.vcs-git.suites " \fIsuite\fR[" ; ...]

 .SH ENVIRONMENT VARIABLES
 .TP
 .BR DGIT_SSH ", " GIT_SSH
 .SH ENVIRONMENT VARIABLES
 .TP
 .BR DGIT_SSH ", " GIT_SSH