summaryrefslogtreecommitdiff
path: root/man/deb-src-control.man
diff options
context:
space:
mode:
authorGuillem Jover <guillem@debian.org>2017-09-17 12:18:15 +0200
committerGuillem Jover <guillem@debian.org>2017-09-24 21:03:10 +0200
commitfca1bfe8406898105d1d724fb808f0cbcf985ae4 (patch)
tree7fc20ba945977bb370d3762f21c84fa1830ee93d /man/deb-src-control.man
parentb3608a01a8ac1416f0620bdf03d497c5b761b244 (diff)
downloaddpkg-fca1bfe8406898105d1d724fb808f0cbcf985ae4.tar.gz
dpkg-buildpackage: Add support for rootless builds
Implement the rootless-builds specification, by honoring the Rules-Requires-Root (R³) field.
Diffstat (limited to 'man/deb-src-control.man')
-rw-r--r--man/deb-src-control.man33
1 files changed, 33 insertions, 0 deletions
diff --git a/man/deb-src-control.man b/man/deb-src-control.man
index 1907eeed1..2f08ff7e5 100644
--- a/man/deb-src-control.man
+++ b/man/deb-src-control.man
@@ -82,6 +82,39 @@ used format is \fIbts-type\fP\fB://\fP\fIbts-address\fP, like
\fBdebbugs://bugs.debian.org\fP. This field is usually not needed.
.TP
+.BR Rules\-Requires\-Root: " \fBno\fP|\fBbinary-targets\fP|\fIimpl-keywords\fP
+This field is used to indicate whether the \fBdebian/rules\fP file requires
+(fake)root privileges to run some of its targets, and if so when.
+.RS
+.TP
+.B no
+The binary targets will not require (fake)root at all.
+.TP
+.B binary\-targets
+The binary targets must always be run under (fake)root.
+This value is the default when the field is omitted; adding the field
+with an explicit \fBbinary\-targets\fP while not strictly needed, marks
+it as having been analyzed for this requirement.
+.TP
+.I impl-keywords
+This is a space-separated list of keywords which define when (fake)root
+is required.
+
+Keywords consist of \fInamespace\fP/\fIcases\fP.
+The \fInamespace\fP part cannot contain "/" or whitespace.
+The \fIcases\fP part cannot contain whitespace.
+Furthermore, both parts must consist entirely of printable ASCII characters.
+
+Each tool/package will define a namespace named after itself and provide
+a number of cases where (fake)root is required.
+(See "Implementation provided keywords" in \fIrootless-builds.txt\fP).
+
+When the field is set to one of the \fIimpl-keywords\fP, the builder will
+expose an interface that is used to run a command under (fake)root.
+(See "Gain Root API" in \fIrootless-builds.txt\fP.)
+.RE
+
+.TP
.BI Vcs\-Arch: " url"
.TQ
.BI Vcs\-Bzr: " url"