(debian-policy.info)Rules-Requires-Root


Prev: Testsuite Up: List of fields
Enter node , (file) or (file)node

5.6.31 ‘Rules-Requires-Root’
----------------------------

Simple field that defines if the source package requires access to root
(or fakeroot) during selected targets in the Note: Main building script;
debian/rules.

The field can consist of exactly one of the following three items:

        - ‘no’: Declares that neither root nor fakeroot is required.
          Package builders (e.g.  dpkg-buildpackage) may choose to
          invoke any target in ‘debian/rules’ with an unprivileged user.

        - ‘binary-targets’ (default): Declares that the package will
          need the root (or fakeroot) when either of the ‘binary’,
          ‘binary-arch’ or ‘binary-indep’ targets are called.  This is
          how every tool behaved before this field was defined.

        - A space separated list of keywords described below.  These
          keywords must always contain a forward slash, which sets them
          apart from the other possible values of ‘Rules-Requires-Root’.
          When this list is provided, the builder must provide a ‘gain
          root command’ (as defined in Note: debian/rules and
          Rules-Requires-Root.) `or' pretend that the value was set
          to ‘binary-targets’, and both the builder and the package’s
          ‘debian/rules’ script must downgrade accordingly (see below).

If the package builder supports the ‘Rules-Requires-Root’ field and
wants to enable the feature, then it must set the environment variable
‘DEB_RULES_REQUIRES_ROOT’ when invoking the package building script
‘debian/rules’.  The value of ‘DEB_RULES_REQUIRES_ROOT’ should be one
of:

        * The value of ‘Rules-Requires-Root’ if the builder can support
          that value.  The builder may trim unnecessary whitespace used
          to format the field for readability.

        * The value ‘binary-targets’ if it cannot support the value of
          ‘Rules-Requires-Root’.

A compliant builder may also leave ‘DEB_RULES_REQUIRES_ROOT’ unset or
set it to ‘binary-targets’ if it has been requested to test whether the
package it builds correctly implements the fall-back for legacy
builders.

Remarks
Definition of the keywords
Provided keywords

automatically generated by info2www version 1.2.2.9