X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=dgit.git;a=blobdiff_plain;f=dgit.1;h=ccf1ea597e111bb447ca86795992ae67f7883001;hp=744c9fc3da9f2fec8b1889bed23c6083eb86f6e8;hb=0457c2d771ef6fe6c0883344add9dd4da0c60917;hpb=60f3915b54a86a37a51f6ba5e5ec204bd58c8d8c diff --git a/dgit.1 b/dgit.1 index 744c9fc3..ccf1ea59 100644 --- a/dgit.1 +++ b/dgit.1 @@ -130,7 +130,7 @@ 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, +dgit checkout will normally need to access 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. @@ -146,7 +146,7 @@ commit. Tagging, signing and actually uploading should be left to dgit push. -dgit's build operations access the the network, +dgit's build operations access the network, to get the -v option right. See -v, below. .TP @@ -212,7 +212,7 @@ 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 -(recalling that dgit options should appear between \fBdgit\fR and +(remember that dgit options should appear between \fBdgit\fR and \fBpbuilder\fR). You should ensure that in your pbuilderrc you do @@ -346,6 +346,8 @@ For why, see .B GITATTRIBUTES in .BR dgit(7) . +Note that only attributes affecting the working tree are suppressed. +git-archive may remain exciting. If there is an existing macro attribute line .B [attr]dgit-defuse-attrs @@ -422,7 +424,7 @@ If this is a problem consider --no-chase-dsc-distro or --force-import-dsc-with-dgit-field. -There is only only sub-option: +There is only one sub-option: .B --require-valid-signature causes dgit to insist that the signature on the .dsc is valid @@ -434,7 +436,7 @@ If .I branch is prefixed with .B + -then if it already exists, it will be simply ovewritten, +then if it already exists, it will be simply overwritten, no matter its existing contents. If .I branch @@ -467,10 +469,30 @@ It may not be useable in a browser. .TP .BI "dgit print-dpkg-source-ignores" Prints the -i and -I arguments which must be passed to dpkg-souce -to cause it to exclude exactly the .git diredcory +to cause it to exclude exactly the .git directory 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 @@ -584,6 +606,13 @@ your git branch is not a descendant of the version in the archive 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. @@ -661,7 +690,7 @@ Also, 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) @@ -679,8 +708,12 @@ And it is only effective with --quilt=unpatched. If ref does not start with refs/ -it is taken to to be a branch - +it is taken 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 @@ -865,7 +898,7 @@ default, in When doing a build, delete any changes files matching .IB package _ version _*.changes before starting. This ensures that -dgit push (and dgit sbuild) will be able to unambigously +dgit push (and dgit sbuild) will be able to unambiguously identify the relevant changes files from the most recent build, even if there have been previous builds with different tools or options. The default is not to remove, but @@ -877,14 +910,20 @@ Note that \fBdgit push-source\fR will always find the right .changes, 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, binary packages, +source packages, .changes files, and so on. + +By default, dgit uses the parent directory .RB ( .. ). -Also see the +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 option -(which this command line option overrides). +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. @@ -1180,7 +1219,13 @@ the default value used if there is no distro-specific setting. One of the values for the command line --clean= option; used if --clean is not specified. .TP -.BR dgit-distro. \fIdistro\fR .quilt-mode +.BR dgit-distro. \fIdistro\fR .clean-mode-newer +Like .clean-mode, +but ignored if the value does not make sense to this version of dgit. +Setting both .clean-mode and .clean-mode-newer is useful +to provide a single git config compatible with different dgit versions. +.TP +.BR dgit-distro. \fIdistro\fR .quilt- One of the values for the command line --quilt= option; used if --quilt is not specified. .TP @@ -1327,7 +1372,7 @@ Default git user.email and user.name for new trees. See .TP .BR gpg ", " dpkg- "..., " debsign ", " git ", " curl ", " dput ", " LWP::UserAgent and other subprograms and modules used by dgit are affected by various -environment variables. Consult the documentaton for those programs +environment variables. Consult the documentation for those programs for details. .SH BUGS There should be