Automatic dependency resolution is one of the most useful features
CHOST vs CBUILD
In order to avoid ambiguity, we use the following terms to indicate different systems when cross-compiling:
- The system on which the build is performed. Dependencies that apply to the CBUILD system can be executed during build time. When cross-compiling, they are not installed into the system being built.
- The system on which the package is going to be executed. When cross-compiling, dependencies applying to CHOST can not be executed.
When not cross-compiling, CBUILD and CHOST have the same value and both classes of dependencies are merged.
Build dependencies are used to specify any dependencies that are required to unpack, patch, compile, test or install the package (but see Implicit System Dependency for exemptions).
Starting with EAPI 7, build dependencies are split into two variables:
BDEPEND specifies dependencies
applicable to CBUILD, i.e. programs that need to be executed during the build,
DEPEND specifies dependencies for CHOST,
i.e. packages that need to be found on built system, e.g. libraries and headers.
In earlier EAPIs, all build dependencies are placed in
RDEPEND ebuild variable should specify any dependencies which are
required at runtime. This includes libraries (when dynamically linked), any data
packages and (for interpreted languages) the relevant interpreter.
Note that when installing from a binary package, only
RDEPEND will be
checked. It is therefore necessary to include items even if they are also listed
Items which are in
RDEPEND but not
DEPEND could in theory be merged
after the target package. Portage does not currently do this.
PDEPEND variable specifies runtime dependencies that do not strictly
require being satisfied immediately. They can be merged after
the package. This variable is used purely to resolve circular dependencies,
while in general case
RDEPEND should be used instead.
Basic Dependency Syntax
DEPEND specification might look like the following:
DEPEND="dev-lang/ruby dev-ruby/ruby-gtk2 dev-ruby/mysql-ruby"
Each package dependency specification is the full category and name of a package. Dependency specifications are separated by arbitrary whitespace — convention is to have one specification per line for readability purposes. When specifying names, the category part should be treated as mandatory.
Sometimes a particular version of a package is needed. Where this is known, it should be specified. A simple example:
This states that at least version 0.9.7d of
openssl is required.
Available version specifiers are:
||Version 1.23 or later is required.|
||A version strictly later than 1.23 is required.|
||Version 1.23 (or any
Exactly version 1.23 is required. If at all possible,
||Version 1.23 or older is required.|
||A version strictly before 1.23 is required.|
To specify "version 2.x (not 1.x or 3.x)" of a package, it is necessary to use the asterisk postfix. This is most commonly seen in situations like:
DEPEND="gtk? ( =x11-libs/gtk+-2* )"
Note that the equals sign is mandatory, and that there is no dot before the
asterisk. Also note that when selecting all versions in a specific
SLOT dependencies should be used (see below).
When two packages (package slots, versions) can not be installed simultaneously, blockers can be used to expose such a conflict to the package manager.
There are two kinds of blockers: weak blockers and strong blockers.
A weak blocker is defined using the following syntax:
The package manager will try to resolve this conflict automatically.
The package blocked by a weak blocker can be uninstalled after
installing the package blocking it. However, it exempts the common
files from file collision checks. Weak blockers are usually used
to solve file collisions between packages and are meaningful only
More specifically, installation of the newer package may overwrite any colliding files that belong to the older package that is explicitly blocked. When such file collisions occur, the colliding files cease to belong to the older package, and they remain installed after the older package is eventually uninstalled. The older package is uninstalled only after any newer blocking packages have been merged on top of it.
DEPENDdo not work correctly. While Portage seemingly queues the package for removal, it does not exempt their contents from file collision checks. Always include your weak blockers in
If it is strictly necessary to resolve the blocker before the package is built (installed), a strong blocker must be used instead. In this case, temporary simultaneous installation of the conflicting packages is not allowed. Strong blockers are expressed using the following syntax:
Strong blockers apply accordingly to the dependency type defining them.
Blockers defined in
RDEPEND are enforced as long as the package
is installed (but do not prevent building binary packages). Blockers
defined purely in
DEPEND are enforced only for building
the package from source, and may not apply once the package is installed
or when it is installed from a binary package.
Specific versions can also be blocked:
Blockers can be optional based upon
USE flags as per normal
Blockers added to older ebuilds should not be expected to be retroactive. If the user already has the ebuild installed, any changes to the ebuild should not be expected to make any difference. This means that you should add the blockers to whichever ebuild is the newest (even if it means that logically it would seem backwards). For example, certain versions of portage don't like some versions of bash, but the blocker was put into bash because that was the newer package that caused the issues.
To depend on a specific
:SLOT should be appended to
the package name, where 'SLOT' is the
SLOT of the package wanted:
DEPEND="qt3? ( x11-libs/qt:3 ) gtk? ( x11-libs/gtk+:2 )
To depend on a specific version or version-range within a SLOT we use:
DEPEND="qt3? ( ~x11-libs/qt-3.3.8:3 ) gtk? ( >=x11-libs/gtk+-2.24.9:2 )
EAPI=5 and higher, you can use slot operators appended to the package
name to declare whether or not your package should be rebuilt after the versions
satisfying its runtime dependencies are updated to versions with a different slot
:=means that any slot is acceptable, and that your package should be rebuilt if the version best matching the runtime dependency is updated to a version with a different slot or subslot;
:*means that any slot is acceptable, and explicitly declares that changes in the slot or sub-slot can be ignored;
:SLOT=means that only the 'SLOT' slot is acceptable, and that your package should be rebuilt if the version matching the runtime dependency is updated to another version with this slot but with a different subslot;
:SLOTmeans that only the 'SLOT' slot is acceptable, and that changes in the sub-slot can be ignored (like in previous EAPIs).
:SLOT/SUBSLOTmeans a dependency on a specific slot and sub-slot pair, which can be useful for packages installing pre-built binaries that require a library with a particular soname version corresponding to the sub-slot.
RDEPEND="media-libs/cogl:1.0= gnutls? ( >=net-libs/gnutls-2.8:= )"
To depend upon a certain package if and only if a given
USE flag is set:
DEPEND="perl? ( dev-lang/perl ) ruby? ( >=dev-lang/ruby-1.8 ) python? ( dev-lang/python )"
It is also possible to depend upon a certain package if a given
USE flag is
RDEPEND="!crypt? ( net-misc/netkit-rsh )"
This should not be used for disabling a certain
USE flag on a given
architecture. In order to do this, the architecture team should add the
flag to their
use.mask file in the
directory of the Gentoo repository.
This can be nested:
DEPEND="!build? ( gcj? ( gtk? ( x11-libs/libXt x11-libs/libX11 x11-libs/libXtst x11-proto/xproto x11-proto/xextproto >=x11-libs/gtk+-2.2 x11-libs/pango ) >=media-libs/libart_lgpl-2.1 ) >=sys-libs/ncurses-5.2-r2 nls? ( sys-devel/gettext ) )"
Any of Many Dependencies
To depend on either
DEPEND="|| ( app-misc/foo app-misc/bar )"
To depend on either
bar if the
USE flag is set:
DEPEND="baz? ( || ( app-misc/foo app-misc/bar ) )"
Any of Many Versus USE
fnord can be built against either
bar. Then a
flag is not necessary if and only if all of the following hold:
fnordis merged on a system which has
foois then unmerged, and
fnordmust continue to work correctly.
A binary package of
fnordmade on a system with
barcan be taken and installed on a system with
Built with USE Dependencies
Available specifiers are:
||foo must have bar enabled.|
||foo must have both bar and baz enabled.|
||foo must have bar disabled and baz enabled.|
There are also shortcuts for conditional situations:
|Compact form||Equivalent expanded form|
Use dependency defaults
If a dependency is introducing or removing a
USE flag in a new package
(-) may be added to the use-dependency
specification to define a default value in case the flag does not exist in the
target package. The
(+) indicates that the missing flag is assumed to be
(-) the opposite.
For example, the following will treat all
boost versions without the
threads flag as having it enabled, and all
gcc versions without
openmp as having it disabled:
DEPEND=" >=dev-libs/boost-1.48[threads(+)] sys-devel/gcc[openmp(-)]"
Tips for Checking Dependencies
It is important to ensure that all the dependencies are complete for your package:
- Look at installed binaries/libraries
Use a tool like
scanelf -n(from app-misc/pax-utils) or
objdump -p(from sys-devel/binutils) to list
- Look in
Look for checks for packages in here. Things to look out for are pkg-config
AM_*functions that check for a specific version.
- Look at included
A good indication of dependencies is to look at the included
.specfiles for relevant deps. However, do not trust them to be the definitive complete list of dependencies.
- Look at the application/library website
- Check the application website for possible dependencies that they suggest are needed
- Read the
INSTALLfor the package
- They usually also contain useful information about building and installing packages
- Remember non-binary dependencies such as pkg-config, doc generation programs, etc.
- Usually the build process requires some dependencies such as intltool, libtool, pkg-config, doxygen, scrollkeeper, gtk-doc, etc. Make sure those are clearly stated.
Implicit System Dependency
All packages have an implicit compile-time and runtime dependency upon the
@system set. It is therefore not necessary, nor advisable, to
specify dependencies upon toolchain packages like
so on, except where specific versions or packages (for example,
uclibc) are required. Note that this rule also needs consideration
for packages like
libtool, which aren't in
@system set for every profile. For example, the embedded profile
libtool ABI might
change and break building order and
flex might get removed from the
@system set in future.
However, packages which are included in the
@system set, or are
@system set packages, should generally include
a complete dependency list (excluding bootstrap packages). This makes
emerge -e @system possible when installing from a stage 1 or stage 2
Packages often have optional dependencies that are needed only when running tests. These should be specified in DEPEND behind a USE flag. Often, the 'test' USE flag is used for this purpose.
Since testing will likely fail when test dependencies are not installed, the test phase should be disabled in this case. This may be accomplished via USE conditionals in the RESTRICT variable.
If other optional features must be enabled/disabled when testing, REQUIRED_USE may be set to express this.
# Define some USE flags IUSE="debug test" # Require debug support when tests are enabled REQUIRED_USE="test? ( debug )" # Disable test phase when test USE flag is disabled RESTRICT="!test? ( test )" # Running tests requires 'foo' to be installed DEPEND="test? ( dev-util/foo )"
Circular dependencies occur if one or more of package's (possibly indirect) dependencies depend on the package itself. This creates a dependency cycle where each of the packages must technically be installed before the other. For example, if package A depends on B, B depends on C and C depends on A, then the package manager cannot install A before C, and C before A.
There are three kinds of circular dependencies:
Circular dependencies that occur if only one of the packages strictly needs
to be installed before the other. For example,
dev-python/setuptoolsto build but the latter package requires the former for some runtime functionality. As a result,
dev-python/certifican be installed later than the other package.
PDEPENDis used to express this and automatically resolve the circular dependency.
Circular dependencies that occur if the cycle applies only to some
combination of USE flags on one of the packages. For example, running tests
dev-python/setuptoolsrequires a number of packages which require
dev-python/setuptoolsto be installed first. This kind of circular dependency can be resolved by the user by adjusting USE flags on one of the packages, e.g. by disabling tests on
dev-python/setuptools, and reenabling them once the dependency is initially installed.
Circular dependencies that cannot be resolved using the regular means.
dev-util/cmakeused to depend on
dev-libs/jsoncpp, while the latter package used the former to build. Resolving this kind of dependency usually requires bundling one of the dependencies conditionally, or providing an alternate bootstrap path.