Gentoo Development Guide
EAPI Usage and Description
This section provides usage and descriptions of the different EAPIs.
Usage of EAPIs
Important
An overview about the important features of each EAPI is provided in the
appendix of the Package Manager Specification. The two-page leaflet
can be printed out, consulted for reference and is available
as app-doc/pms in the main tree.
If EAPI is undefined in an ebuild, then EAPI="0" is selected. If you want to override the EAPI variable, you have to specify it at the top of the ebuild:
# Copyright 1999-2010 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: $
EAPI=1
inherit eutils
Important
EAPI must only be defined in ebuild files, not eclasses. (eclasses may have EAPI-conditional code)
EAPI="1"
-
Default src_compile Phase Function
Support for the
ECONF_SOURCEvariable, which is also supported byeconf, has been added to the defaultsrc_compileimplementation.src_compile() { if [[ -x ${ECONF_SOURCE:-.}/configure ]] ; then econf fi if [ -f Makefile ] || [ -f GNUmakefile ] || [ -f makefile ] ; then emake || die "emake failed" fi } -
SLOT dependencies
Any valid atom can be constrained to match a specific SLOT. This is accomplished by appending a colon to the atom, followed by a SLOT value.
SLOT dependency examples:
x11-libs/qt:3~x11-libs/qt-3.3.8:3>=x11-libs/qt-3.3.8:3=x11-libs/qt-3.3*:3
-
IUSE defaults
Add + or - before the name of the use flag in IUSE to turn it on or off by default.
Important
The default USE-ordering is
USE_ORDER="env:pkg:conf:defaults:pkginternal:env.d"(see man make.conf)Important
Disabling default IUSE is pretty much useless as it does not override the profile and user config (make.conf and package.use)
# Copyright 1999-2010 Gentoo Foundation # Distributed under the terms of the GNU General Public License v2 # $Header: $ EAPI=1 IUSE="foo +bar"
EAPI="2"
Helpers
-
doman Language Support
domanautomatically detects language codes and puts it in the appropriate directory.doman foo.1 # will go into /usr/share/man/man1/foo.1 doman foo.lang.1 # will go into /usr/share/man/lang/man1/foo.1 with EAPI="2"
Metadata
-
Blocker Atoms
-
New Meaning for Old Syntax
Blocker atoms which use the previously existing !atom syntax now have a slightly different meaning. These blocker atoms indicate that conflicting packages may be temporarily installed simultaneously. When temporary simultaneous installation of conflicting packages occurs, the installation of a newer package may overwrite any colliding files that belong to an older package which 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.
-
New !!atom Syntax
A new !!atom syntax is now supported, for use in special cases for which temporary simultaneous installation of conflicting packages should not be allowed. If a given package happens to be blocked by a mixture of atoms consisting of both the !atom and !!atom syntaxes, the !!atom syntax takes precedence over the !atom syntax.
-
-
USE Dependencies
It is possible to depend on USE-flags of packages.
Examples:
foo[bar]means that package foo must have USE-flag bar enabledfoo[bar,baz]means that the package foo must have both the bar and baz USE-flags enabledfoo[-bar,baz]means that the package foo must have the bar USE-flag disabled and baz USE-flag enabledfoo[bar?]meansbar? ( foo[bar] ) !bar? ( foo )foo[!bar?]meansbar? ( foo ) !bar? ( foo[-bar] )foo[bar=]meansbar? ( foo[bar] ) !bar? ( foo[-bar] )foo[!bar=]meansbar? ( foo[-bar] ) !bar? ( foo[bar] )
-
Customization of Output File Names in SRC_URI
A new syntax is supported which allows customization of the output file name for a given URI. In order to customize the output file name, a given URI should be followed by a "
->" operator which, in turn, should be followed by the desired output file name. As usual, all tokens, including the operator and output file name, should be separated by whitespace.Example:
SRC_URI="http://dl.google.com/earth/client/GE4/release_4_3/GoogleEarthLinux.bin -> GoogleEarthLinux-${PV}.bin"
Phases
-
New
src_preparePhase FunctionA new src_prepare function is called after the
src_unpackfunction, with cwd initially set to$S. -
New
src_configurePhase FunctionThe configure portion of the
src_compilefunction has been split into a separate function which is namedsrc_configure. Thesrc_configurefunction is called in-between thesrc_prepareandsrc_compilefunctions.The default
src_configureandsrc_compilefunctions in EAPI=2:src_configure() { if [[ -x ${ECONF_SOURCE:-.}/configure ]] ; then econf fi } src_compile() { if [ -f Makefile ] || [ -f GNUmakefile ] || [ -f makefile ] ; then emake || die "emake failed" fi } -
Execution Order of Phase Functions
pkg_setupsrc_unpacksrc_preparesrc_configuresrc_compilesrc_testsrc_installpkg_preinstpkg_postinstpkg_prermpkg_postrm
-
Default Phase Functions
The default
pkg_nofetchandsrc_*phase functions are now accessible via a function having a name that begins withdefault_and ends with the respective phase function name. For example, a call to a function with the namedefault_src_compileis equivalent to a call to the defaultsrc_compileimplementation.The default phase functions are:
default_pkg_nofetchdefault_src_unpackdefault_src_preparedefault_src_configuredefault_src_compiledefault_src_test
-
Default Phase Function Alias
A function named "
default" is redefined for each phase so that it will call thedefault_*function corresponding to the current phase. For example, a call to the function named "default" during thesrc_compilephase is equivalent to a call to the function nameddefault_src_compile.
EAPI="3"
-
Gentoo Prefix support
Support for the
EPREFIX,EROOT, andEDvariables. If an ebuild uses one of these, it must be EAPI3 aware. See Gentoo Prefix Techdocs for more information. -
unpack supports .xz and .tar.xz
The
unpackcommand supports xz-archives and xz-compressed tar files.
EAPI="4"
Helpers
-
utilities die on their own, unless the nonfatal command is used
Ebuild functions all die on their own in EAPI=4. In case that this non-zero exit status is expected, you may call
nonfatal function [arg,...].Example:
EAPI=1 ... src_install() { emake DESTDIR="${D}" install || die "make install failed" dodoc ChangeLog README }EAPI=4 ... src_install() { emake DESTDIR="${D}" install nonfatal dodoc ChangeLog README } -
recursive dodoc
dodocsupports-ras the first argument, which leadsdodocto install the specified documentation directory recursively into the docdir.Example:
src_install() { default dodoc ChangeLog dodoc -r doc/ } -
doins symlink supports
Within EAPI=4,
doinssupports installing symlinks as symlinks when installing recursively. For older EAPIs, the symlink behaviour is undefined. -
dosed and dohard are banned
The
dosedanddohardcommands are banned in this EAPI. -
econf adds --disable-dependency-tracking
Within EAPI=4,
econfadds--disable-dependency-trackingto the default configure options. -
controllable compression via docompress
To compress files in the destination-folder
${D}, thedocompresscommand may be used insrc_install. To control which items should be compressed and which shouldn't be compressed, you may include or exclude directories or plain files. The default inclusion list contains:/usr/share/doc/usr/share/info/usr/share/man
/usr/share/doc/${PF}/html
If the first argument of
docompressis-x, the items specified will be added to the exclusion list, otherwise they will be added to the inclusion list.Note
When
docompressis called, it is not required that the paths specified as its arguments are pointing to existing files or directories. However, if a file still doesn't exist whensrc_installhas completed, it will be ignored with a warning.
Metadata
-
use dependencies default
In addition to the use-deps specified in EAPI=2, a
(+)or(-)may be added to the use-dep to define a default-value in case the use-flag does not exist in the given package. The(+)means that this use-flag is assumed to be enabled,(-)the opposite.Example:
DEPEND=" >=dev-libs/boost-1.32[boost(+)] sys-devel/gcc[openmp(-)]"
Phases
-
new pkg_pretend phase
The new
pkg_pretendphase can be used to do sanity checks before the main phase function sequence is run (meaning this phase is executed after the package manager has calculated the dependencies and before installing them). This phase typically checks for a kernel configuration and mayeerroranddiewhen needed.Important
There is no guarantee that the ebuild's dependencies are installed when this phase is called.
Important
As
pkg_pretendis not called in the main phase function sequence, environment saving is not guaranteed.Example:
# Copyright 1999-2009 Gentoo Foundation # Distributed under the terms of the GNU General Public License v2 # $Header: $ EAPI="4" inherit linux-info ... CONFIG_CHECK="FUSE_FS" ERROR_FUSE_FS="this is an unrealistic testcase..." pkg_pretend() { if use kernel_linux ; then if [[ -e "${ROOT}"/usr/src/linux/.config ]] ; then if kernel_is lt 2 6 30 ; then check_extra_config fi fi fi } -
default src_install is no longer a no-op
The default
src_installfunction in EAPI=4:src_install() { if [[ -f Makefile ]] || [[ -f GNUmakefile]] || [[ -f makefile ]] ; then emake DESTDIR="${D}" install fi if ! declare -p DOCS >/dev/null 2>&1 ; then local d for d in README* ChangeLog AUTHORS NEWS TODO CHANGES THANKS BUGS \ FAQ CREDITS CHANGELOG ; do [[ -s "${d}" ]] && dodoc "${d}" done # TODO: wrong "declare -a" command... elif declare -p DOCS | grep -q `^declare -a` ; then dodoc "${DOCS[@]}" else dodoc ${DOCS} fi } -
pkg_info for non-installed packages
The
pkg_infofunction may also be called by the package manager for non-installed packages. Ebuild writers should note that dependencies may not be available.
Variables
-
REQUIRED_USE
The
REQUIRED_USEvariable contains a list of assertions that must be met by the configuration of USE flags to be valid for this ebuild. In order to be matched, a USE flag in a terminal element must be enabled (or disabled if it has an exclamation mark prefix).Essentially,
REQUIRED_USEis an analogue ofDEPENDstyle syntax. For example, to state that some combination is forbidden, i.e. "iffoois set,barmust be unset":REQUIRED_USE="foo? ( !bar )"To state "if
foois set, then at least one ofbar,baz, andquuxmust be activated":REQUIRED_USE="foo? ( || ( bar baz quux ) )"To state "exactly one of
foo,bar, orbazmust be set, but not several":REQUIRED_USE="^^ ( foo bar baz )"Note that the last relationship is that of an Exclusive OR (XOR). While an XOR could be formed from usual
DEPENDsyntax, a specific^^operator has been added for this case.Important
See section conflicting-use-flags for when (and when not) to use
REQUIRED_USE. -
REPLACING_VERSIONS and REPLACED_BY_VERSION
The
REPLACING_VERSIONSvariable contains a whitespace-separated list of all versions (PVR) of this package that are being replaced (uninstalled or overwritten) as a result of this install. It is a list, not a single optional value, to handle pathological cases such as installingfoo-2:2to replacefoo-2:1andfoo-3:2.REPLACING_VERSIONSis valid inpkg_preinstandpkg_postinst. In addition, it may be available inpkg_pretendandpkg_setup, although you should take care to handle binary package creation and installation correctly when using it in these phases.The
REPLACED_BYvariable contains the single version (PVR) of this package that is replacing us, if we are being uninstalled as part of an install, or an empty string otherwise. It is valid inpkg_prermandpkg_postrm. -
MERGE_TYPE
The
MERGE_TYPEvariable contains the type of package that is being merged. Possible values are:source- if building and installing a package from source,
binary- if installing a binary package,
buildonly- if building a binary package without installing it.
-
AA and KV variables are gone
The
AAandKVvariables are no longer set in EAPI=4. -
no more RDEPEND="${DEPEND}"
When
RDEPENDis unset, there will no longer be an automatic assignment ofRDEPEND="${DEPEND}".