← Back to branch summary

~ubuntu-branches/ubuntu/precise/devscripts/precise

« back to all changes in this revision

Viewing changes to scripts/cowpoke.1

  • Committer: Bazaar Package Importer
  • Author(s): Benjamin Drung
  • Date: 2011-05-25 09:46:30 UTC
  • Revision ID: james.westby@ubuntu.com-20110525094630-gsd820t94ib5u6kn
Tags: 2.11.0ubuntu1
https://launchpad.net/bugs/429288
* Merge from Debian unstable; remaining changes:
  - Demote Recommends to Suggests:
    + libcrypt-ssleay-perl: only needed for a corner case (uscan on SSL
      download sites), wasn't installed by default in previous releases
      either, and seems quite dead upstream; universe only.
    + debian-{keyring,maintainers}: not useful enough in Ubuntu; universe
      only.
    + equivs: too much of a hack to install by default; universe only.
    + libyaml-syck-perl: transition-check is fairly Debian-specific.
  - scripts/debchange.{pl,1}:
    + Adjust --security template for Ubuntu.
    + Add -U/--upstream flag that forces original "just increment
      the end" behaviour; Ubuntu is upstream for some pieces of software.
    + Add --distributor= and DEBCHANGE_DISTRIBUTOR to override lsb_release
      output.
    + Default to "oneiric" as distribution.
    + Add "ubuntu1" to version string for new versions, with tweaks for
      special cases.
    + Add -R/--rebuild flag for Ubuntu's no-change rebuilds.
    + Don't use the last distribution in debian/changelog when doing
      "dch -r" on Ubuntu. "Just because it was last uploaded to jaunty
      doesn't mean that's the right thing to do now." Thanks to Colin
      Watson. (LP: #429288)
  - Add test/debchange.pl, test/Makefile: debchange test suite.
  - Rename XS-Vcs-* to XS-Debian-Vcs-*.

Show diffs side-by-side

added added

removed removed

Lines of Context:
scripts/cowpoke.1
22
22
.RI [ options ] " packagename.dsc"
23
23
 
24
24
.SH DESCRIPTION
25
 
Uploads a Debian source package to a cowbuilder host and builds it,
 
25
Uploads a Debian source package to a \fBcowbuilder\fR host and builds it,
26
26
optionally also signing and uploading the result to an incoming queue.
27
27
 
28
28
 
55
55
 
56
56
.TP
57
57
.B \-\-create
58
 
Create the remote cowbuilder root if it does not already exist.  If this option
 
58
Create the remote \fBcowbuilder\fR root if it does not already exist.  If this option
59
59
is not passed it is an error for the specified \fB\-\-dist\fP or \fB\-\-arch\fP
60
 
to not have an existing cowbuilder root in the expected location.
 
60
to not have an existing \fBcowbuilder\fR root in the expected location.
61
61
 
62
62
.TP
63
63
.BR \-\-return= [ \fIpath ]
64
 
Copy results of the build to \fIpath\fP.  If path is not specified, then return
65
 
them to the current directory. The given path must exist, it will not be created.
 
64
Copy results of the build to \fIpath\fP.  If \fIpath\fP is not specified, then return
 
65
them to the current directory. The given \fIpath\fP must exist, it will not be created.
66
66
 
67
67
.TP
68
68
.B \-\-no\-return
69
69
Do not copy results of the build to \fBRETURN_DIR\fP (overriding a path set for
70
 
it in the config files).
 
70
it in the configuration files).
71
71
 
72
72
.TP
73
73
.BI \-\-dpkg\-opts= "'opt1 opt2 ...'"
96
96
 
97
97
.TP
98
98
.B BUILDD_HOST
99
 
The network address or fqdn of the build machine where cowbuilder is configured.
 
99
The network address or fqdn of the build machine where \fBcowbuilder\fR is configured.
100
100
This may be overridden by the \fB\-\-buildd\fP command line option.
101
101
.TP
102
102
.B BUILDD_USER
103
103
The unprivileged user name for operations on the build machine.  This defaults
104
104
to the local name of the user executing \fBcowpoke\fP (or to a username that is
105
 
specified in your ssh config for \fBBUILDD_HOST\fR), and may be overridden by the
 
105
specified in your SSH configuration for \fBBUILDD_HOST\fR), and may be overridden by the
106
106
\fB\-\-buildd\-user\fP command line option.
107
107
.TP
108
108
.B BUILDD_ARCH
145
145
.TP
146
146
.B BUILDD_ROOTCMD
147
147
The command to use to gain root privileges on the remote build machine.  If
148
 
unset the default is \fBsudo\fP(8).  This is only required to invoke cowbuilder
 
148
unset the default is \fBsudo\fP(8).  This is only required to invoke \fBcowbuilder\fR
149
149
and allow it to enter its chroot, so you may restrict this user to only being
150
150
able to run that command with escalated privileges.  Something like this in
151
 
sudoers will enable invoking cowbuilder without an additional password entry
 
151
sudoers will enable invoking \fBcowbuilder\fR without an additional password entry
152
152
required:
153
153
.TP
154
154
.B " "
157
157
.RE
158
158
.TP
159
159
.B " "
160
 
Alternatively you could use ssh with a forwarded key, or whatever other
 
160
Alternatively you could use SSH with a forwarded key, or whatever other
161
161
mechanism suits your local access policy.  Using \fBsu \-c\fR isn't really
162
162
suitable here due to its quoting requirements being somewhat different to
163
163
the rest.
217
217
 
218
218
 
219
219
.SH COWBUILDER CONFIGURATION
220
 
There is nothing particularly special required to configure a cowbuilder instance
 
220
There is nothing particularly special required to configure a \fBcowbuilder\fR instance
221
221
for use with \fBcowpoke\fP.  Simply create them in the flavour you require with
222
 
`\fBcowbuilder \-\-create\fP` according to the cowbuilder documentation, then
 
222
`\fBcowbuilder \-\-create\fP` according to the \fBcowbuilder\fR documentation, then
223
223
configure \fBcowpoke\fP with the user, arch, and path information required to
224
224
access it, on the machines you wish to invoke it from (or alternatively configure
225
225
\fBcowpoke\fP with the path, arch and distribution information and pass the
226
226
\fB\-\-create\fP option to it on the first invocation).  The build host running
227
 
cowbuilder does not require \fBcowpoke\fP installed locally.
 
227
\fBcowbuilder\fR does not require \fBcowpoke\fP installed locally.
228
228
 
229
229
The build machine should have the \fBlintian\fP and \fBdevscripts\fR packages
230
230
installed for post-build sanity checking.  Upon completion, the build log and
236
236
save on some transfers of the \fIorig.tar.*\fP when building subsequent Debian
237
237
revisions).
238
238
 
239
 
The user executing \fBcowpoke\fP must have ssh access to the build machine as
240
 
the \fBBUILDD_USER\fP.  That user must be able to invoke cowbuilder as root by
 
239
The user executing \fBcowpoke\fP must have SSH access to the build machine as
 
240
the \fBBUILDD_USER\fP.  That user must be able to invoke \fBcowbuilder\fR as root by
241
241
using the \fBBUILDD_ROOTCMD\fP.  Signing keys are not required to be installed
242
242
on the build machine (and will be ignored there if they are).  If the package
243
243
is signed, keys will be expected on the machine that executes \fBcowpoke\fP.
244
244
 
245
 
When \fBcowpoke\fP is invoked, it will first attempt to update the cowbuilder
 
245
When \fBcowpoke\fP is invoked, it will first attempt to update the \fBcowbuilder\fR
246
246
image if that has not already been done on the same day.  This is checked by
247
247
the presence or absence of a \fIcowbuilder-$arch-$dist-update-log-$date\fP file
248
248
in the \fBINCOMING_DIR\fP.  You may move, remove, or touch this file if you wish
249
249
the image to be updated more or less often than that.  Its contents log the
250
 
output of cowbuilder during the update (or creation) of the build root.
 
250
output of \fBcowbuilder\fR during the update (or creation) of the build root.
251
251
 
252
252
 
253
253
.SH NOTES