Differences between revisions 59 and 60
Revision 59 as of 2014-08-31 14:03:30
Size: 10338
Editor: josch
Comment: remove the namespace syntax
Revision 60 as of 2014-09-01 13:09:28
Size: 11565
Editor: josch
Comment: Update table for implementation status of the new spec
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
Preliminary support of this spec was implemented in Preliminary support of this spec was implemented in.

|| '''program''' || '''version''' || '''bug''' || '''vcs commit''' ||
|| dpkg || || DebianBug:760158 || ||
|| sbuild || || DebianBug:731798 || ||
|| apt || || || ||
|| python-apt || || || ||
|| debhelper || || || ||
|| pbuilder || || DebianBug:740577 || ||
|| lintian || || || ||
|| dose3 || || || ||
|| wanna-build || || || ||
|| dak || || DebianBug:744246 || ||
|| devscripts (mk-build-deps) || || || ||
|| python-debian || || || ||
|| libconfig-model-dpkg-perl || || || ||
|| augeas || || || ||
|| haskell-debian || || || ||

{{{#!wiki comment/dashed

For historical purposes, here is the list of versions, bugs and commits that
implemented the original proposal with only one <> block, namespaces and
a complicated resolution mechanic:
Line 6: Line 29:
|| dpkg || 1.17.2 || DebianBug:661538 || [[http://anonscm.debian.org/gitweb/?p=dpkg/dpkg.git;a=commit;h=7662e0937bb064a0754d12605d80a96a17e2aadf|git:7662e093]] [[http://anonscm.debian.org/gitweb/?p=dpkg/dpkg.git;a=commit;h=c87941de954281a8aa66d032c85657f64bfe4dce|git:c87941de]]||
|| sbuild || || DebianBug:731798 || ||
|| apt || 0.9.16.1 || DebianBug:661537 || [[http://anonscm.debian.org/gitweb/?p=apt/apt.git;a=commit;h=565ded7b65240b25ad8551789ac388c8ce72b1f4|git:565ded7b]] [[http://anonscm.debian.org/gitweb/?p=apt/apt.git;a=commit;h=ce7f128c020e1347f91c6074238fc5da58c5df71|git:ce7f128c]] ||
|| dpkg || 1.17.2 || DebianBug:661538 || [[http://anonscm.debian.org/cgit/dpkg/dpkg.git/commit/?id=7662e0937bb064a0754d12605d80a96a17e2aadf|git:7662e093]] [[http://anonscm.debian.org/cgit/dpkg/dpkg.git/commit/?id=c87941de954281a8aa66d032c85657f64bfe4dce|git:c87941de]]||
|| apt || 0.9.16.1 || DebianBug:661537 || [[http://anonscm.debian.org/cgit/apt/apt.git/commit/?id=565ded7b65240b25ad8551789ac388c8ce72b1f4|git:565ded7b]] [[http://anonscm.debian.org/cgit/apt/apt.git/commit/?id=ce7f128c020e1347f91c6074238fc5da58c5df71|git:ce7f128c]] ||
Line 10: Line 32:
|| debhelper || 9.20140227 || || [[http://anonscm.debian.org/gitweb/?p=debhelper/debhelper.git;a=commit;h=f16d0915b10ff9ef0b0826ae896aaccd6f3ad84f|git:f16d0915b]] ||
|| pbuilder || || DebianBug:740577 || ||
|| lintian || 2.5.22 || DebianBug:740607 || [[http://anonscm.debian.org/gitweb/?p=lintian/lintian.git;a=commit;h=1f8821b8b62205aa36eadbd799faad443cfa8b85|git:1f8821b8]] ||
|| dose3 || 3.1 (partial) || || ||
|| wanna-build || || || ||
|| dak || || DebianBug:744246 || ||
|| devscripts (mk-build-deps) |||||| Uses libdpkg-perl so supports build profiles automatically ||
|| python-debian || || || ||
|| libconfig-model-dpkg-perl || 2.051 || || [[https://anonscm.debian.org/cgit/pkg-perl/packages/libconfig-model-dpkg-perl.git/commit/?id=373cb3d014288ea73efccb96ff7f9c37f738538c|git:373cb3d0]] ||
|| augeas || || || ||
|| haskell-debian || || || ||
|| debhelper || 9.20140227 || || [[http://anonscm.debian.org/cgit/debhelper/debhelper.git/commit/?id=f16d0915b10ff9ef0b0826ae896aaccd6f3ad84f|git:f16d0915b]] ||
|| lintian || 2.5.22 || DebianBug:740607 || [[http://anonscm.debian.org/cgit/lintian/lintian.git/commit/?id=1f8821b8b62205aa36eadbd799faad443cfa8b85|git:1f8821b8]] ||
|| dose3 || 3.1 (partial) || || [[https://gforge.inria.fr/plugins/scmgit/cgi-bin/gitweb.cgi?p=dose/dose.git;a=commitdiff;h=e8c0a518c56560e0bef5d81f0ff36450d7c6743b|git:e8c0a518]] [[https://gforge.inria.fr/plugins/scmgit/cgi-bin/gitweb.cgi?p=dose/dose.git;a=commitdiff;h=6268adba6929275e17771b185fafb259410503db|git:6268adba]] ||
|| libconfig-model-dpkg-perl || 2.051 || || [[http://anonscm.debian.org/cgit/pkg-perl/packages/libconfig-model-dpkg-perl.git/commit/?id=373cb3d014288ea73efccb96ff7f9c37f738538c|git:373cb3d0]] ||
}}}

Document status

Preliminary support of this spec was implemented in.

program

version

bug

vcs commit

dpkg

760158

sbuild

731798

apt

python-apt

debhelper

pbuilder

740577

lintian

dose3

wanna-build

dak

744246

devscripts (mk-build-deps)

python-debian

libconfig-model-dpkg-perl

augeas

haskell-debian

Problem description

For some compilation scenarios it is required to build-depend on a different set of binary packages than specified in the Build-Depends line. The two most important scenarios are:

  • Bootstrapping (for breaking build dependency cycles) and

  • Cross building (for source packages having different build dependencies during cross building than during native building)

This specification describes an extension of the Build-Depends field syntax. The extensions allow the marking of build dependencies as being needed or not needed when one or more build profiles are activated. It also defines a new field called "Build-Profiles" which, depending on the context marks binary packages as being built or not built with a certain set of build profiles activated or marks binary packages as having been built with a certain set of build profiles activated.

Build profiles can be activated by setting the environment variable DEB_BUILD_PROFILES or by using the -P option with dpkg-buildpackage (or -o Apt::Build-Profiles for apt, or --profiles in sbuild). More than one build profile can be activated at a time. Multiple profiles are specified by separating them with commas in commandline arguments and by separating them with spaces in the DEB_BUILD_PROFILES environment variable. The initial profile names are "stage1", "stage2", "nocheck", "nodoc", "nobiarch" and "cross".

Build-Depends syntax extension (restriction formulas)

An example demonstrating the restriction formula syntax for build profiles:

Build-Depends: foo (>= 1.0) [i386 arm] <!stage1> <!cross>, bar

This specification introduces a new pair of brackets (using < as the opening and > as the closing bracket) to be used after the architecture qualification list. The < and > brackets enclose a whitespace separated list of terms called a restriction list. But in contrast to architecture qualification there can be multiple < and > enclosed restriction lists. The list of restriction lists is called a restriction formula and individual restriction lists are separated by whitespace.

Every term in a restriction list refers to the name of a build profile (see above for a list). Terms can be negated by using an exclamation mark as a prefix just as architectures in the architecture qualification list. In contrast to the architecture qualification list, positive and negative terms are allowed to be mixed.

The terms arranged as a restriction formula form a disjunctive normal form expression. This is, each term within a restriction list is AND-ed together while the restriction lists in a restriction formula are OR-ed together. This also means that the order of terms within restriction lists and the order of restriction lists within a restriction formula does not matter. A term evaluates to "true" if the profile with the same name was set for the build. It defaults to false if the profile was not set. In the example above, the package would depend on foo for i386 or arm and if neither the profile stage1 nor the profile cross are active.

Second example:

Build-Depends: foo <stage1 cross>

In this case, the source package would build depend on foo only if both, the profile stage1 and cross are active.

Third example:

Build-Depends: foo <stage1 cross> <stage1>

In this case, the source package would build depend on foo if either both, stage1 and cross are active or if the profile stage1 is active. This means that the dependency is not applied if the profile cross alone is active.

The Build-Profiles field

In debian/control binary package stanzas, the content of the Build-Profiles field specifies the condition for which that binary package does or does not build. To express that condition, the same restriction formula syntax from the Build-Depends field is used.

Build-Profiles: <!cross> <!stage1>

If a binary package stanza in a debian/control file does not contain a Build-Profiles field, then it implicitly means that it builds with all build profiles (including none at all).

The Built-For-Profiles field

In *.changes and Packages files, the content of the Built-For-Profiles field specifies the white space separated list of build profiles with which that binary or source package was built.

The DEB_BUILD_PROFILES environment variable

The DEB_BUILD_PROFILES environment variable contains a space separated unordered list of activated profiles. The content of this variable must be honored by all tools involved in package compilation. Here an example for debian/rules (enabling sql for any build except stage1 profile - notice the negated test):

ifneq ($(filter stage1,$(DEB_BUILD_PROFILES)),)
    DH_OPTIONS += -Nlibdb5.1-sql # not needed with debhelper (>= 9.20140227)
    CONFIGURE_SWITCHES += --disable-sql
else
    CONFIGURE_SWITCHES += --enable-sql
endif

Profile built binary packages

A binary package must offer the exact same functionality for all profiles with which it builds including no activated profile at all (if it builds in that case). Otherwise a package depending on that binary package might not find the functionality it expects it to provide. This means that if necessary binary packages have to be split or that a source package has to be built in two stages. This requirement can not technically be checked before ReproducibleBuilds happen.

This requirement is does not apply if the "stage1" or "nodoc" profile is active. In this case, only the parts of the package that expose a functional interface (scripts, programs, libraries, headers) must not be different. Non-functional interfaces like documentation can be different or missing in the produced binary packages.

Example

Imagine src:foo depends on bar which is needed to build a plugin that is shipped together with other plugins in the package foo-plugins. When bar is made optional as a build dependency of src:foo in a stage1 build, then the resulting stage1 binary package foo-plugins would differ from the foo-plugins package that is created during a full build. Thus the creation of the foo-plugins binary package must be disabled by using the Build-Profiles field in the foo-plugins binary package stanza and by adding the necessary bits to debian/rules for packages without debhelper or when build depending on debhelper (>> 9.20140227) is not desired.

If foo-plugins has reverse dependencies which are part of a cycle with src:foo itself, then not building foo-plugins would not solve the bootstrap problem. In that case it is necessary to either:

  • split the foo-plugins package into foo-plugins-nobar and foo-plugins-bar and adjust *all* reverse dependencies of foo-plugins to correctly depend on foo-plugins-nobar and foo-plugins-bar

  • or create a package foo-plugins-nobar during a stage1 build and modify only the reverse dependencies that are in a cycle with src:foo to build depend on foo-plugins-nobar in their own stage1 build. When src:foo is built fully, it will not produce foo-plugins-nobar anymore but the full foo-plugins package instead.

Other uses for the restriction syntax

Mark build dependencies that need to be translated when cross building

See CrossTranslatableBuildDeps#A3._Use_restriction_syntax_with_new_namespace

Replace Build-Depends-Indep and Build-Depends-Arch

Instead of moving build dependencies needed to build arch:all or arch:any packages into Build-Depends-Indep and Build-Depends-Arch, respectively, mark them directly in the Build-Depends field using <debbuildopt.archindep> and <debbuildopt.archdep>, respectively.

Map DEB_BUILD_OPTIONS to namespaces

Some DEB_BUILD_OPTIONS like nocheck or noopt could be mapped to <debbuildopt.nocheck> or <debbuildopt.noopt>. This would allow not needing to install certain dependencies if certain DEB_BUILD_OPTIONS are active.

Discussion