.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "git-debpush 1" .TH git-debpush 1 "Debian Project" "perl v5.32.1" "git-debpush" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" git\-debpush \- create & push a git tag with metadata for an ftp\-master upload .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBgit debpush\fR [\fIoption\fR...] .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBgit-debpush\fR is a wrapper around \fBgit\-tag\fR\|(1) and \fBgit\-push\fR\|(1). It helps you create and push a specially formatted signed tag which indicates that the tagged commit should be pushed (or \*(L"uploaded\*(R") to a Debian-style archive. .PP Typically, your git server will be configured to notify an intermediary service of the new tag that you pushed. That service will then fetch your tag, check your \s-1PGP\s0 signature, do any conversion that's needed (such as producing and signing a \fB.dsc\fR and \&\fB.changes\fR), and upload the result to the Debian-style archive. .PP \&\fBgit-debpush\fR is only for source-only uploads. .SH "TYPICAL USAGE" .IX Header "TYPICAL USAGE" \&\fBgit-debpush\fR is designed such that for regular uploads of your package, you should be able to just invoke it without passing any command line arguments. After you've built and tested some .debs, run \&\fBdch\fR\|(1) to finalise your changelog and committed the result, just type \&\*(L"git debpush\*(R", and the intermediary service and your distribution's autobuilder network will take care of the rest. .PP The most common exception to this is the first time you use \&\fBgit-debpush\fR for a non-native package. You will need to pass a quilt mode option to inform the intermediary service which git branch format you are using, for example .Sp .Vb 1 \& % git debpush \-\-gbp .Ve .PP if you are using the git branch format typically used with \fBgbp\fR\|(1). See \*(L"\s-1QUILT MODE OPTIONS\*(R",\s0 below, for the available quilt mode options. .PP Aside from a few sanity checks to help avoid broken uploads, \&\fBgit-debpush\fR does not do anything with the information provided by the quilt mode option. It simply embeds the corresponding quilt mode in its generated tag, for use by the intermediary service. .PP Future invocations of \fBgit-debpush\fR will try to read the quilt mode out of the tag generated by \fBgit-debpush\fR for your previous upload. You can override that on the command line by passing a quilt mode option, which always takes precedence. .SH "SETUP FOR SOURCE FORMAT 1.0" .IX Header "SETUP FOR SOURCE FORMAT 1.0" \&\fBgit-debpush\fR needs to tell the intermediary git service whether this is a native or non-native package. Given historical Debian practices, it is not sufficient for either \fBgit-debpush\fR or the intermediary service to rely on the version number in debian/changelog. .PP If you are using one of the 3.0 source package formats, \fBgit-debpush\fR will just look in debian/source/format to determine whether the package is native or non-native, and you can ignore this section of the manpage. .PP If you are using the 1.0 source package format \*(-- either debian/source/format does not exist, or contains the string \*(L"1.0\*(R" \*(-- then \fBgit-debpush\fR must be told whether the package is native or non-native. We do this using debian/source/options. If your package is non-native, execute .Sp .Vb 1 \& % echo "\-sn" >>debian/source/options .Ve .PP If your package is native, execute .Sp .Vb 1 \& % echo "\-sk" >>debian/source/options .Ve .PP (With source format 1.0, \fBdpkg\-source\fR\|(1) decides whether the package is native or non-native based on the presence of absence of an orig.tar in \fB..\fR, but \fBgit-debpush\fR is a pure git tool that never looks at tarballs.) .SH "QUILT MODE OPTIONS" .IX Header "QUILT MODE OPTIONS" .IP "\fB\-\-quilt=gbp\fR|\fB\-\-gbp\fR" 4 .IX Item "--quilt=gbp|--gbp" You are using the 'unapplied' branch format, typically used with \&\fBgbp\fR\|(1). .IP "\fB\-\-quilt=dpm\fR|\fB\-\-dpm\fR" 4 .IX Item "--quilt=dpm|--dpm" You are using \fBgit\-dpm\fR\|(1)'s branch format. .IP "\fB\-\-quilt=baredebian[+git]\fR|\fB\-\-baredebian[+git]\fR" 4 .IX Item "--quilt=baredebian[+git]|--baredebian[+git]" You are using the 'bare debian' branch format, with the upstream source in the form of an upstream tag. .Sp \&\fB\-\-quilt=baredebian+git\fR is an alias for \fB\-\-quilt=baredebian\fR. .IP "\fB\-\-quilt=linear\fR" 4 .IX Item "--quilt=linear" You are using the 'manually maintained applied' branch format or similar, and each commit touching the upstream source not already represented in debian/patches should be added as a new patch. .IP "\fB\-\-quilt=smash\fR" 4 .IX Item "--quilt=smash" You are using the 'manually maintained applied' branch format or similar, and you want all changes to the upstream source to be squashed into a single patch in debian/patches. .IP "\fB\-\-quilt=auto\fR" 4 .IX Item "--quilt=auto" Tell the intermediary service to try \fB\-\-quilt=linear\fR, and if that cannot succeed, fall back to \fB\-\-quilt=smash\fR. .IP "\fB\-\-quilt=nofix\fR" 4 .IX Item "--quilt=nofix" You are using the 'manually maintained applied' branch format or similar, and you don't want debian/patches to be touched by the intermediary service. .Sp If all commits touching the upstream source are not already represented in debian/patches, the intermediary service will fail to upload your package. .SH "OTHER OPTIONS" .IX Header "OTHER OPTIONS" .IP "\fB\-\-no\-push\fR|\fB\-n\fR" 4 .IX Item "--no-push|-n" Just tag, don't push. .IP "\fB\-u\fR \fIkeyid\fR" 4 .IX Item "-u keyid" Passed on to \fBgit\-tag\fR\|(1). .IP "\fB\-\-branch=\fR\fI\s-1BRANCH\s0\fR" 4 .IX Item "--branch=BRANCH" Where to place the tag, i.e., what you want to release. If unspecified, we put the tag on whatever \s-1HEAD\s0 points to. .Sp Note that this need not actually be a branch, but any committish (see \&\fBgitglossary\fR\|(7)). The option name is chosen to fit what is by far the most common case. .IP "\fB\-\-upstream=\fR\fI\s-1TAG\s0\fR" 4 .IX Item "--upstream=TAG" When pushing a non-native package, \&\fBgit-debpush\fR needs a tag for the upstream part of your package. .Sp By default \fBgit-debpush\fR asks \fBgit\-deborig\fR\|(1), which searches for a suitable tag based on the upstream version in debian/changelog. .IP "\fB\-\-remote=\fR\fI\s-1REMOTE\s0\fR" 4 .IX Item "--remote=REMOTE" Where to push tags and branches. If unspecified, use the remote which git would use if you typed \*(L"git push \s-1BRANCH\*(R".\s0 .IP "\fB\-\-distro=\fR\fI\s-1DISTRO\s0\fR" 4 .IX Item "--distro=DISTRO" What distribution name to embed in the signed tag. Defaults to \&\*(L"debian\*(R". .IP "\fB\-\-force\fR|\fB\-f\fR" 4 .IX Item "--force|-f" Ignore the results of all checks designed to prevent broken uploads. .IP "\fB\-\-force\fR=\fIcheck\fR[,\fIcheck\fR] ..." 4 .IX Item "--force=check[,check] ..." Override individual checks designed to prevent broken uploads. May be specified more than once. .Sp Using \fB\-\-force\fR or \fB\-\-force=\fR\fIcheck\fR might cause the upload to fail at some later point in the process. .Sp Valid values for \fIcheck\fR are: .RS 4 .IP "\fBsuite\fR" 4 .IX Item "suite" Permit uploading to a different suite than the target of the most recent upload made with \fBgit-debpush\fR (e.g. when uploading to Debian unstable after uploading to Debian experimental). .IP "\fBupstream-nonancestor\fR" 4 .IX Item "upstream-nonancestor" Ignore the fact that the upstream tag is not an ancestor of the branch to be tagged (skipping this check is implied by \fB\-\-quilt=baredebian\fR). .IP "\fBupstream-nonidentical\fR" 4 .IX Item "upstream-nonidentical" Ignore any differences between the upstream source in the upstream tag and the upstream source in the branch to be tagged (this check is only run when using \fB\-\-quilt=gbp\fR or \fB\-\-quilt=unapplied\fR). .IP "\fBpatches-applicable\fR" 4 .IX Item "patches-applicable" Ignore any failures of the following two checks: .RS 4 .IP "\(bu" 4 With \fB\-\-quilt=gbp\fR, \fB\-\-quilt=unapplied\fR, \fB\-\-quilt=baredebian\fR, \&\fB\-\-quilt=dpm\fR, and \fB\-\-quilt=nofix\fR, the quilt patches should apply cleanly to the upstream source with \fBgit\-apply\fR\|(1). .IP "\(bu" 4 With \fB\-\-quilt=dpm\fR and \fB\-\-quilt=nofix\fR, applying the quilt patches to the upstream source should produce exactly the source tree to be tagged. .RE .RS 4 .RE .IP "\fBunreleased\fR" 4 .IX Item "unreleased" Permit upload to a suite called \s-1UNRELEASED.\s0 .IP "\fBdgit-view\fR" 4 .IX Item "dgit-view" Ignore apparently pushing the dgit view of a package (as produced by \&\fBdgit clone\fR) to the maintainer branch, where the dgit view and the maintainer view of the package are not identical. .IP "\fBunstitched\fR" 4 .IX Item "unstitched" Ignore the fact that the branch to be pushed seems to be a \&\fBgit\-debrebase\fR\|(1) branch in an unstitched state (see \fBgit\-debrebase\fR\|(5)). .RE .RS 4 .RE .IP "\fBdetached\fR" 4 .IX Item "detached" Ignore the fact that \s-1HEAD\s0 is to be tagged, but \s-1HEAD\s0 is detached (this check is only run when \fB\-\-branch=HEAD\fR or no \fB\-\-branch\fR option is specified). .SH "SEE ALSO" .IX Header "SEE ALSO" Git branch formats in use by Debian maintainers: .SH "AUTHOR" .IX Header "AUTHOR" \&\fBgit-debpush\fR and this manpage were written by Sean Whitton with much input from Ian Jackson .