← Back to branch summary

~ubuntu-branches/ubuntu/utopic/devscripts/utopic

« back to all changes in this revision

Viewing changes to scripts/cowpoke.1

  • Committer: Package Import Robot
  • Author(s): James McCoy, Benjamin Drung, Guillem Jover, Paul Wise, James McCoy, Christoph Berg, Ron Lee, David Prévot
  • Date: 2014-08-04 22:34:17 UTC
  • mfrom: (10.10.12 sid)
  • Revision ID: package-import@ubuntu.com-20140804223417-jzo8pb55dujbihud
Tags: 2.14.6
http://bugs.debian.org/756067
http://bugs.debian.org/752152
http://bugs.debian.org/753657
[ Benjamin Drung ]
* suspicious-source: Add image/tiff, application/pgp-keys, and image/x-icon
  to whitelisted mime-types. Add .gmo to whitelisted file extensions.
* wrap-and-sort: Add --max-line-length option with a default of 79 characters
  (it was previously hard-coded to 80 characters).  (Closes: #756067)

[ Guillem Jover ]
* nmudiff: Send control messages inline.  (Closes: #752152)

[ Paul Wise ]
* rmadison: bpo madison is dead, remove it
* rmadison: add new to the defaults for Debian
* rmadison: document the defaults in the manual page

[ James McCoy ]
* namecheck: Remove berlios, since it no longer hosts code.  (Closes:
  #752382)
* mk-build-deps:
  + Provide the package name, not file name, to “dpkg --remove” when package
    install fails.
  + Read all of the output from “apt-cache showsrc” to ensure mk-build-deps
    doesn't get stuck waiting for apt-cache to exit.
  + Pass the name of the .deb file out of build_equiv to ensure the correct
    .deb is installed.  (Closes: #753657)

[ Christoph Berg ]
* Update all qa.debian.org URLs to https://.

[ Ron Lee ]
* cowpoke:
  + Allow more flexibility for specialised build chroots.
    It's now possible to specify arbitrary 'dist' names, with arbitrary
    special configurations on top of the real BASE_DIST suite.  This means
    it's easy to have things like a chroot for wheezy-backports which will
    be able to pull other deps from the backports repo, while still having
    a pristine wheezy build chroot on the same build host.  Or to have a
    staging chroot for unstable, with extra build deps pulled in from a
    local repository, or installed manually, while still having a pristine
    sid chroot for building other packages to upload.  And it all works the
    same as normal, you just pass --dist=wheezy_bpo to select the chroot.
  + Allow SIGN_KEYID and UPLOAD_QUEUE to be overridden per arch/dist.
    This makes a lot more sense now that the above is easily possible.
    People can use that for private or work (in progress) builds too, and
    this can reduce the chance of accidentally uploading to the wrong place,
    or signing some package not intended for upload with a key that would
    would let it be accepted by dak.
  + Better handling of --debbuildopts.  There were some corner cases for
    this where the required quoting of options could be rather weird in the
    intersection of all the layers it might get passed through. This should
    make it more forgiving and better able to always DTRT.

[ David Prévot ]
* uscan.1: Use +dfsg suffix in examples

Show diffs side-by-side

added added

removed removed

Lines of Context:
scripts/cowpoke.1
45
45
to using one or the other consistently as this name may be used in file paths
46
46
and to locate old packages for comparison reporting.
47
47
 
 
48
It is now also possible to use locally defined names with this option, when
 
49
used in conjunction with the \fBBASE_DIST\fP option in a configuration file.
 
50
This permits the maintenance and use of specially configured build chroots,
 
51
which can source package dependencies from the backports archives or a local
 
52
repository, or have other unusual configuration options set, without polluting
 
53
the chroots you use for clean package builds intended for upload to the main
 
54
repositories.  See the description of \fBBASE_DIST\fP below.
 
55
 
48
56
.TP
49
57
.BI \-\-buildd= host
50
58
Specify the remote host to build on.
59
67
is not passed it is an error for the specified \fB\-\-dist\fP or \fB\-\-arch\fP
60
68
to not have an existing \fBcowbuilder\fR root in the expected location.
61
69
 
 
70
The \fB\-\-buildd\-user\fP must have permission to create the \fBRESULT_DIR\fP
 
71
on the build host, or an admin with the necessary permission must first create
 
72
it and give that user (or some group they are in) write access to it, for this
 
73
option to succeed.
 
74
 
62
75
.TP
63
76
.BR \-\-return= [ \fIpath ]
64
77
Copy results of the build to \fIpath\fP.  If \fIpath\fP is not specified, then return
76
89
\fBDEBBUILDOPTS\fP in the build host's \fIpbuilderrc\fP.
77
90
 
78
91
.TP
 
92
.BI \-\-create\-opts= "'cowbuilder option'"
 
93
Specify additional arguments to be passed verbatim to \fBcowbuilder\fR when a
 
94
chroot is first created (using the \fB\-\-create\fP option above). If multiple
 
95
arguments need to be passed, this option should be specified separately for
 
96
each of them.
 
97
 
 
98
E.g., \fB\-\-create\-opts "\-\-othermirror" \-\-create\-opts "deb http:// ..."\fP
 
99
 
 
100
This option will override any \fBCREATE_OPTS\fP specified for a chroot in the
 
101
cowpoke configuration files.
 
102
 
 
103
.TP
 
104
.BI \-\-update\-opts= "'cowbuilder option'"
 
105
Specify additional arguments to be passed verbatim to \fBcowbuilder\fR if the
 
106
base of the chroot is updated.  If multiple arguments need to be passed, this
 
107
option should be specified separately for each of them.
 
108
 
 
109
This option will override any \fBUPDATE_OPTS\fP specified for a chroot in the
 
110
cowpoke configuration files.
 
111
 
 
112
.TP
 
113
.BI \-\-build\-opts= "'cowbuilder option'"
 
114
Specify additional arguments to be passed verbatim to \fBcowbuilder\fR when
 
115
a package build is performed.  If multiple arguments need to be passed, this
 
116
option should be specified separately for each of them.
 
117
 
 
118
This option will override any \fBBUILD_OPTS\fP specified for a chroot in the
 
119
cowpoke configuration files.
 
120
 
 
121
.TP
79
122
.B \-\-help
80
123
Display a brief summary of the available options and current configuration.
81
124
 
92
135
will \fBnot\fP be performed on them.
93
136
 
94
137
.SS Global defaults
95
 
These apply to every arch and dist in a single cowpoke invocation.
 
138
These apply to every \fIarch\fP and \fIdist\fP in a single cowpoke invocation.
96
139
 
97
140
.TP
98
141
.B BUILDD_HOST
123
166
be placed.  This must be writable by the \fBBUILDD_USER\fP.
124
167
.TP
125
168
.B PBUILDER_BASE
126
 
The filesystem root for all pbuilder COW and result files.  Arch and dist
 
169
The filesystem root for all pbuilder CoW and result files.  \fIArch\fP and \fIdist\fP
127
170
specific subdirectories will normally be created under this.  The apt cache
128
171
and temporary build directory will also be located under this path.
129
172
 
130
173
.TP
131
174
.B SIGN_KEYID
132
 
If this option is set, it is expected to contain the gpg key id to pass to
 
175
If this option is set, it is expected to contain the gpg key ID to pass to
133
176
\fBdebsign\fP(1) if the packages are to be remotely signed.  You will be prompted
134
177
to confirm whether you wish to sign the packages after all builds are complete.
135
178
If this option is unset or an empty string, no attempt to sign packages will be
136
 
made.
 
179
made.  It may be overridden on an \fIarch\fP and \fIdist\fP specific basis using
 
180
the
 
181
.IB arch _ dist _SIGN_KEYID
 
182
option described below.
 
183
 
137
184
.TP
138
185
.B UPLOAD_QUEUE
139
186
If this option is set, it is expected to contain a 'host' specification for
141
188
be prompted to confirm whether you wish to upload the packages after they are
142
189
signed.  If this option is unset or an empty string, no attempt to upload packages
143
190
will be made.  If \fBSIGN_KEYID\fP is not set, this option will be ignored entirely.
 
191
It may be overridden on an \fIarch\fP and \fIdist\fP specific basis using the
 
192
.IB arch _ dist _UPLOAD_QUEUE
 
193
option described below.
 
194
 
144
195
 
145
196
.TP
146
197
.B BUILDD_ROOTCMD
190
241
\fBdebdiff\fP(1), and for upload with \fBdput\fP(1).  If this option is not
191
242
specified for some arch and dist combination then it will default to
192
243
.I $PBUILDER_BASE/$arch/$dist/result
193
 
.
194
244
 
195
245
.TP
196
246
.IB arch _ dist _BASE_PATH
197
 
The directory where the COW master files are to be found (or created if the
 
247
The directory where the CoW master files are to be found (or created if the
198
248
\fB\-\-create\fP command line option was passed).  If this option is not specified
199
249
for some arch or dist then it will default to
200
250
.I $PBUILDER_BASE/$arch/$dist/base.cow
201
251
 
 
252
.TP
 
253
.IB arch _ dist _BASE_DIST
 
254
The code name to pass as the \fB\-\-distribution\fP option for cowbuilder instead
 
255
of \fIdist\fP.  This is necessary when \fIdist\fP is a locally significant name
 
256
assigned to some specially configured build chroot, such as 'wheezy_backports',
 
257
and not the formal suite name of a distro release known to debootstrap.  This
 
258
option cannot be overridden on the command line, since it would rarely, if ever,
 
259
make any sense to change it for individual invocations of \fBcowpoke\fP. If this
 
260
option is not specified for an arch and dist combination then it will default to
 
261
.IR dist .
 
262
 
 
263
.TP
 
264
.IB arch _ dist _CREATE_OPTS
 
265
A bash array containing additional options to pass verbatim to \fBcowbuilder\fP
 
266
when this chroot is created for the first time (using the \fB\-\-create\fP option).
 
267
This is useful when options like \fB\-\-othermirror\fP are wanted to create
 
268
specialised chroot configurations such as 'wheezy_backports'.  By default this
 
269
is unset.  All values set in it will be overridden if the \fB\-\-create\-opts\fP
 
270
option is passed on the command line.
 
271
 
 
272
Each element in this array corresponds to a single argument (in the ARGV sense)
 
273
that will be passed to cowbuilder.  This ensures that arguments which may contain
 
274
whitespace or have strange quoting requirements or other special characters will
 
275
not be mangled before they get to cowbuilder.
 
276
 
 
277
Bash arrays are initialised using the following form:
 
278
 
 
279
    OPTS=( "arg1" "arg 2" "\-\-option" "value" "\-\-opt=val" "etc. etc." )
 
280
 
 
281
.TP
 
282
.IB arch _ dist _UPDATE_OPTS
 
283
A bash array containing additional options to pass verbatim to \fBcowbuilder\fP
 
284
each time the base of this chroot is updated.  It behaves similarly to the
 
285
\fBCREATE_OPTS\fP option above, except for acting when the chroot is updated.
 
286
 
 
287
.TP
 
288
.IB arch _ dist _BUILD_OPTS
 
289
A bash array containing additional options to pass verbatim to \fBcowbuilder\fP
 
290
each time a package build is performed in this chroot.  This is useful when you
 
291
want to use some option like \fB\-\-twice\fP which cowpoke does not directly
 
292
need to care about.  It otherwise behaves similarly to \fBUPDATE_OPTS\fP above
 
293
except that it acts during the build phase of \fBcowbuilder\fP.
 
294
 
 
295
.TP
 
296
.IB arch _ dist _SIGN_KEYID
 
297
An optional arch and dist specific override for the global SIGN_KEYID option.
 
298
 
 
299
.TP
 
300
.IB arch _ dist _UPLOAD_QUEUE
 
301
An optional arch and dist specific override for the global UPLOAD_QUEUE option.
 
302
 
202
303
 
203
304
.SH CONFIGURATION FILES
204
305
.TP