EBUILD

章节: Portage (5)
更新: 2023年4月
索引返回主内容

名称

ebuild - ebuild 脚本中的内部格式、变量和函数

描述

ebuild(1) 程序接受一个 ebuild 脚本作为参数。该脚本包含变量和命令，指定如何从其原始源下载、解压、修补、编译、安装和合并特定软件包。除此之外，ebuild 脚本还可以根据需要包含安装前/安装后/删除前/删除后命令。所有 ebuild 脚本都用 bash 编写。ebuild 对 Bash 的最低版本要求取决于 EAPI 版本。

依赖项

依赖项原子仅仅是 Portage 在计算软件包之间关系时使用的依赖项。请注意，如果原子尚未合并，则会匹配可用的最新版本。

原子基础

原子基础只是一个完整的类别/包名。完整类别/包名的另一个名称是“catpkg”。您会发现此简写名称在 Gentoo 中经常使用。以下是一些原子基础，也就是“catpkg”

net-misc/dhcp
sys-apps/sed
sys-libs/zlib

原子版本

更具体地说明仅接受原子的某些版本会更好。请注意，版本必须与前缀组合（见下文）。因此，您可以将版本号作为后缀添加到基础中。

示例:

        sys-apps/sed-4.0.5
        sys-libs/zlib-1.1.4-r1
        net-misc/dhcp-3.0_p2

版本通常由用点分隔的两个或三个数字组成，例如 1.2 或 4.5.2。此字符串后面可以跟一个字符，例如 1.2a 或 4.5.2z。请注意，此字母并不表示 Alpha、Beta 等状态。为此，请使用可选后缀；_alpha、_beta、_pre（预发布）、_rc（候选发布版）或 _p（补丁）。这意味着对于软件包的第 3 个预发布版本，您将使用类似 1.2_pre3 的内容。此处后缀可以任意链接，没有限制。

原子前缀运算符 [> >= = <= <]

有时您希望能够依赖于通用版本，而不是一直指定确切的版本。因此，我们提供了标准的布尔运算符

示例:

        >media-libs/libgd-1.6
        >=media-libs/libgd-1.6
        =media-libs/libgd-1.6
        <=media-libs/libgd-1.6
        <media-libs/libgd-1.6

扩展原子前缀 [!ti] 和后缀 [*]

现在更进一步，我们提供了定义阻塞包和版本范围匹配的功能。另请注意，这些扩展前缀/后缀可以以任何方式与上面定义的原子类组合。

ti

表示匹配指定的基础版本的任何修订版。因此，在下面的示例中，我们将匹配版本“1.0.2a”、“1.0.2a-r1”、“1.0.2a-r2”等。

示例:

        tinet-libs/libnet-1.0.2a

!

表示阻止同时安装软件包。

示例:

        !app-text/dos2unix

!!

表示阻止同时安装软件包，并明确禁止在升级系列期间临时同时安装它们。此语法从EAPI 2开始支持。

示例:

        !!<sys-apps/portage-2.1.4_rc1

*

表示匹配软件包的任何版本，只要匹配指定的基准即可。因此，对于版本“2*”，我们可以匹配“2.1”、“2.2”、“2.2.1”等，而不匹配版本“1.0”、“3.0”、“4.1”等。在没有“*”的情况下，版本部分之前的内容必须是有效的版本。例如，“2”是有效版本，“2.”不是。因此，“2*”是允许的，“2.*”是不允许的。

示例:

        =dev-libs/glib-2*
        !=net-fs/samba-2*

原子槽

从EAPI 1开始，任何原子都可以限制为匹配特定的槽。这是通过附加冒号后跟槽来实现的

示例:

        x11-libs/qt:3
        tix11-libs/qt-3.3.8:3
        >=x11-libs/qt-3.3.8:3
        =x11-libs/qt-3.3*:3

子槽

从EAPI 5开始，槽依赖项可以包含一个可选的子槽部分，该部分位于常规槽之后，并由/字符分隔。

示例:

        dev-lang/perl:0/5.12
        dev-libs/icu:0/0
        dev-libs/icu:0/49
        dev-libs/glib:2/2.30

原子槽运算符

从EAPI 5开始，槽运算符依赖项由冒号后跟以下运算符之一组成

*

表示任何槽值都是可以接受的。此外，对于运行时依赖项，表示如果匹配的软件包被卸载并替换为不同槽中匹配的其他软件包，则软件包不会中断。

示例:

        dev-lang/perl:*
        dev-libs/glib:*
        dev-libs/icu:*

=

表示任何槽值都是可以接受的。此外，对于运行时依赖项，表示除非在安装软件包时可用的最佳已安装版本的槽和子槽等于槽和子槽，否则软件包将中断。

示例:

        dev-libs/glib:=
        dev-lang/perl:=
        dev-libs/icu:=

slot=

表示仅接受特定的槽值，否则其行为与普通等于槽运算符完全相同。

示例:

        dev-lang/perl:0=
        dev-libs/glib:2=
        dev-libs/icu:0=

要实现等于槽运算符，软件包管理器需要存储匹配软件包的最佳已安装版本的槽/子槽对。此语法仅供软件包管理器使用，ebuild 必须不得使用。软件包管理器可以通过在保存软件包的依赖项时在冒号和等号之间插入相应的槽/子槽对来执行此操作。此处不得省略子槽部分（当 SLOT 变量省略子槽部分时，该软件包被视为具有等于常规槽的隐式子槽）。

示例:

        dev-lang/perl:0/5.12=
        dev-libs/glib:2/2.30=
        dev-libs/icu:0/0=
        dev-libs/icu:0/49=

原子 USE

从EAPI 2开始，任何原子都可以限制为匹配特定的USE标志设置。当与槽依赖项一起使用时，USE依赖项出现在槽依赖项的右侧。

无条件 USE 依赖项

示例	含义

foo[bar,baz]	foo 必须同时启用 bar 和 baz
foo[-bar,baz]	foo 必须禁用 bar 并启用 baz

条件 USE 依赖项

紧凑形式	等效扩展形式

foo[!bar?]	bar? ( foo ) !bar? ( foo[-bar] )
foo[bar=]	bar? ( foo[bar] ) !bar? ( foo[-bar] )
foo[!bar=]	bar? ( foo[-bar] ) !bar? ( foo[bar] )

原子 USE 默认值

从EAPI 4开始，USE依赖项可以指定关于可能或可能不存在于匹配软件包的IUSE中的标志值的默认假设。此类默认值通过在标志后立即跟随(+)或(-)来指定。使用(+)表示缺少的标志存在且已启用，或使用(-)表示缺少的标志存在且已禁用

示例:

        media-video/ffmpeg[threads(+)]
        media-video/ffmpeg[-threads(-)]

动态依赖项

有时程序可能根据 USE 变量依赖于不同的内容。Portage 提供了一些选项来处理此问题。请注意，使用以下语法时，每个情况都被视为其出现范围内的 1 个原子。这意味着每个原子都条件地包含多个原子，并且可以嵌套到无限深度。

usevar? ( Atom )

要在用户在USE中启用 jpeg 时包含 jpeg 库，只需使用以下语法

jpeg? ( media-libs/libjpeg-turbo )

!usevar? ( Atom )

如果只想在用户在USE变量中没有某个选项时才包含软件包，则使用以下语法

!nophysfs? ( dev-games/physfs )

这在您希望为功能添加可选支持并默认启用它时通常很有用。

usevar? ( Atom if true ) !usevar? ( Atom if false )

对于像 C 中找到的三元运算符这样的功能，您必须使用两个语句，一个正常语句和一个反向语句。如果软件包使用 GTK3 或 GTK2，但两者都不使用，则可以像这样处理

gtk3? ( =x11-libs/gtk+-3* ) !gtk3? ( =x11-libs/gtk+-2* )

这样，默认值就是更高级的 GTK3 库。

|| ( Atom Atom ... )

当软件包可以与一些不同的软件包一起工作但虚拟包不合适时，可以使用此语法。

示例:

|| (
        app-games/unreal-tournament
        app-games/unreal-tournament-goty
)

这里我们看到 unreal-tournament 有一个普通版本和一个 goty 版本。由于它们提供了相同的基本文件集，因此另一个软件包可以使用两者之一。由于范围很小，因此添加虚拟包是不合适的。

另一个很好的例子是当软件包可以使用多个视频接口构建时，但它只能始终只有一个。

示例:

|| (
        sdl? ( media-libs/libsdl )
        svga? ( media-libs/svgalib )
        opengl? ( virtual/opengl )
        ggi? ( media-libs/libggi )
        virtual/x11
)

这里只会选择其中一个软件包，并且优先级顺序由它们出现的顺序决定。因此，sdl 最有可能被选择，其次是 svga，然后是 opengl，然后是 ggi，如果用户没有指定任何先前的选择，则默认为 X。

请注意，如果列出的任何软件包已合并，软件包管理器将使用它来认为依赖项已满足。

变量使用说明

*: 在make.conf(5) 中定义的变量可用于 ebuild（除了 Portage 特定的变量，其他软件包管理器可能不支持）。
*: 在 ebuild 中为变量赋值时，您不能在变量名和等号之间留有空格。
*: 变量值只能包含属于ascii(7) 字符集的字符。此要求由GLEP 31强制执行。

ebuild 中使用的变量

ARCH

此变量包含当前运行系统架构的官方 Gentoo 特定首字母缩写词。有关权威列表，请查看 /var/db/repos/gentoo/profiles/arch.list。

P

此变量包含不带 ebuild 修订版的包名。此变量绝不能修改。

示例:

        x11-base/xorg-server-1.20.5-r2 --> 'xorg-server-1.20.5'

PN

包含脚本名称，不包含版本号。

示例:

        x11-base/xorg-server-1.20.5-r2 --> 'xorg-server'

PV

包含版本号，不包含修订号。

示例:

        x11-base/xorg-server-1.20.5-r2 --> '1.20.5'

PR

包含修订号，如果不存在修订号则为“r0”。

示例:

        x11-base/xorg-server-1.20.5-r2 --> 'r2'

PVR

包含版本号和修订号（如果有）。

示例:

        x11-base/xorg-server-1.20.5 --> '1.20.5'
        x11-base/xorg-server-1.20.5-r2 --> '1.20.5-r2'

PF

包含完整包名 PN-PVR

示例:

        x11-base/xorg-server-1.20.5 --> 'xorg-server-1.20.5'
        x11-base/xorg-server-1.20.5-r2 --> 'xorg-server-1.20.5-r2'

CATEGORY

包含包类别名称。

示例:

        x11-base/xorg-server-1.20.5-r2 --> 'x11-base'

A

包含包所需的所有源文件。此变量必须未定义，它由 SRC_URI 变量自动生成。

WORKDIR = ${PORTAGE_TMPDIR}/portage/${CATEGORY}/${PF}/work

包含包构建根目录的路径。请勿修改此变量。

FILESDIR = ${PORTAGE_TMPDIR}/${CATEGORY}/${PF}/files

包含包特定辅助文件所在的目录路径。请勿修改此变量。

EBUILD_PHASE

包含当前正在执行的阶段函数的缩写名称，例如“setup”、“unpack”、“compile”或“preinst”。

EBUILD_PHASE_FUNC

从 EAPI 5 开始，包含当前正在执行的阶段函数的完整名称，例如“pkg_setup”、“src_unpack”、“src_compile”或“pkg_preinst”。

EPREFIX

从 EAPI 3 开始，包含 Portage 在安装期间配置的偏移量。在 ebuild 或 eclass 中有时需要偏移量，并且在这种情况下可用，例如 ${EPREFIX}。EPREFIX 不包含尾部斜杠，因此不存在的偏移量由空字符串表示。请勿修改此变量。

S = ${WORKDIR}/${P}

包含临时构建目录的路径。此变量由函数src_compile和src_install使用。两者都以S作为当前目录执行。此变量可以修改为匹配包的 tarball 的提取目录。

T = ${PORTAGE_TMPDIR}/portage/${CATEGORY}/${PF}/temp

包含临时目录的路径。您可以将其用于任何您喜欢的内容。

D = ${PORTAGE_TMPDIR}/portage/${CATEGORY}/${PF}/image/

包含临时安装目录的路径。每个不涉及辅助工具和函数（如下所示）的写入操作都应以 ${D} 为前缀。从 EAPI 3 开始，此处通常需要考虑偏移量前缀，为此提供了变量 ${ED}（见下文）。请注意，使用 EAPI 7，此路径中包含的任何尾部斜杠将自动删除，以便于在 ebuild 中连接路径。请勿修改此变量。

ED = ${PORTAGE_TMPDIR}/portage/${CATEGORY}/${PF}/image/${EPREFIX}/

从 EAPI 3 开始，包含路径“${D%/}${EPREFIX}/”，用于方便起见。对于 EAPI 3 之前的 EAPI 值，它们不支持 ED，帮助程序在它们原本使用 ED 的地方使用 D。请注意，使用 EAPI 7，此路径中包含的任何尾部斜杠将自动删除，以便于在 ebuild 中连接路径。请勿修改此变量。

MERGE_TYPE

从 EAPI 4 开始，可以使用 MERGE_TYPE 变量查询当前的合并类型。此变量将包含以下可能值之一

值	含义

buildonly	未计划合并的源构建
source	已计划合并的源构建

PROVIDES_EXCLUDE = [空格分隔的 fnmatch 模式列表]

这些 fnmatch 模式匹配的 soname 和文件路径将在生成 PROVIDES 元数据期间被排除（参见 portage(5)）。模式由空格分隔，并且可以创建包含带引号的空格的模式。

PORTAGE_LOG_FILE

包含构建日志的路径。如果 PORTAGE_LOGDIR 变量未设置，则 PORTAGE_LOG_FILE="${T}/build.log"。

PORTAGE_SOCKS5_PROXY

包含到 SOCKSv5 代理的 UNIX 套接字路径，该代理提供主机网络访问。仅在网络沙箱内运行且代理可用时才可用（请参阅 make.conf(5) 中的网络沙箱）。

REPLACED_BY_VERSION

从 EAPI 4 开始，可以在 pkg_prerm 和 pkg_postrm 中使用 REPLACED_BY_VERSION 变量查询正在替换当前包的包版本。如果没有替换包，则变量将为空，否则将包含单个版本号。

REPLACING_VERSIONS

从 EAPI 4 开始，可以在 pkg_pretend、pkg_setup、pkg_preinst 和 pkg_postinst 中使用 REPLACING_VERSIONS 变量查询当前包正在替换的包版本。如果没有要替换的包，则变量将为空，否则将包含与要替换的包版本相对应的空格分隔的版本号列表。通常，此变量不会包含多个版本，但根据 PMS，它可以包含多个版本。

REQUIRES_EXCLUDE = [空格分隔的 fnmatch 模式列表]

这些 fnmatch 模式匹配的 soname 和文件路径将在生成 REQUIRES 元数据期间被排除（参见 portage(5)）。模式由空格分隔，并且可以创建包含带引号的空格的模式。

ROOT = /

请注意有关 ROOT 变量的一个重要的最新更改——在 EAPI 7 ebuild 中，当指向根文件系统时，此变量在 ebuild 中默认为 "" 而不是传统的 "/"，并且当设置为非根路径时，此变量将永远不会包含尾部斜杠。这增加了方便性，消除了连接路径时指定 "${ROOT%/}" 的需要，使 ROOT 的使用更优雅。这也适用于变量 EROOT、D 和 ED。请注意，这意味着 ebuild 必须在条件语句中使用不同的逻辑来确定它们是否安装到根文件系统——使用 [[ "$ROOT" == "" ]] 而不是 [[ "$ROOT" == "/" ]]。

包含 Portage 应用作活动文件系统根目录的路径。当包希望对活动文件系统进行更改时，它们应该在以 ${ROOT} 为前缀的树中执行此操作。此处通常需要考虑偏移量前缀，为此提供了变量 ${EROOT}（见下文）。请勿修改此变量。

EROOT = ${ROOT%/}${EPREFIX}/

从 EAPI 3 开始，包含“${ROOT%/}${EPREFIX}/”，用于方便起见。请勿修改此变量。另请参见上面有关 EAPI 7 中 ROOT 的重要说明。与 ROOT 一样，当设置为根文件系统时，EROOT 将定义为 ""，并且在 ebuild 中永远不会有尾部斜杠。

BROOT = ${EPREFIX}

从 EAPI 7 开始，包含构建依赖项（由 BDEPEND 满足）的绝对路径，通常是可执行的构建工具。这包括任何适用的偏移量前缀。请勿修改此变量。

DESCRIPTION = 一个快乐的小包

应包含对包的简短描述。

EAPI = 0

定义此包符合的 ebuild API 版本。如果未定义，则默认为“0”。如果 Portage 不识别 EAPI 值，则它将屏蔽包并拒绝对其执行任何操作，因为这意味着需要首先安装更新版本的 Portage。为了最大限度地提高向后兼容性，包应符合尽可能低的 EAPI。请注意，任何使用此包的 ebuild(1) 命令的用户都需要具有识别此包符合的 EAPI 的 Portage 版本。

SRC_URI = https://example.com/path/${P}.tar.gz

包含所需源文件的 URI 列表。它可以包含单个源文件的多个 URI。如果在任何 GENTOO_MIRRORS 上都找不到该文件，则按顺序处理该列表。从 EAPI 2 开始，可以使用右侧的“->”运算符自定义给定 URI 的输出文件名，后跟所需的输出文件名。所有标记，包括运算符和输出文件名，都应由空格分隔。

HOMEPAGE = https://example.com/

应包含源主站点和包其他相关信息的 URI 列表。

KEYWORDS = [-ti][x86,ppc,sparc,mips,alpha,arm,hppa,...]

KEYWORDS 与 ACCEPT_KEYWORDS（参见 make.conf(5)）一起工作，以实现创建不同类型的包集的系统，然后可以批量屏蔽或取消屏蔽这些包集。在 Gentoo Linux 项目中，它们由 Gentoo 架构团队用于定义特定 CPU 架构的稳定和不稳定未屏蔽包集中包含哪些 ebuild。

它们的工作原理如下。为了解释起见，让我们假设您有一个稳定的 x86-64 位系统，通常称为“amd64”。ARCH 将定义为“amd64”。如果您使用的是 Gentoo Linux 的稳定版本，则 ACCEPT_KEYWORDS 将通过配置文件设置为“amd64”。然后，任何在 KEYWORDS 中具有“amd64”的 ebuild 都会默认取消屏蔽。

在“不稳定”的 amd64 系统上，ACCEPT_KEYWORDS 将设置为“amd64 tiamd64”，其中波浪号表示“不稳定”。然后，如果 ebuild 在 KEYWORDS 中具有“amd64”或“tiamd64”，则它将在该系统上默认按关键字取消屏蔽。类似地，如果已知某个 ebuild 与特定架构不兼容，则可以指定“-”前缀（即“-amd64”）设置以仅在该架构上屏蔽它。如果您正在为 Gentoo Linux 开发 ebuild，则有一些关于 KEYWORDS 的策略，您需要遵循这些策略以与 Gentoo 的架构团队工作流程保持一致。下面列出了最重要的策略

*: 如果您不知道某个 ebuild 是否在特定架构下运行，则不要在 KEYWORDS 中指定它。然后它将在该架构上默认屏蔽。
*: 如果已知 ebuild 不适用于某个架构，请在 KEYWORDS 中禁用该架构。例如，这可以通过指定“-ppc”来完成。这将确保它在该架构上明确按关键字屏蔽。
*: 向 Gentoo Linux 提交 ebuild 时，项目的策略是仅在已成功测试的架构的 KEYWORDS 中设置“tiarch”，而不是更多。随着 ebuild 获得更多测试，Gentoo 架构团队将逐渐扩展 KEYWORDS 设置以将包“提升”到不稳定状态，并可能提升到稳定状态。
可以使用配置文件中的 package.accept_keywords 和 package.keywords 文件，在每个包的基础上自定义 ACCEPT_KEYWORDS 和 KEYWORDS 的行为。有关使用这些文件的更多信息，请参见 portage(5)。

请注意，虽然其他基于 Gentoo 的项目具有 KEYWORDS 和 ACCEPT_KEYWORDS，但它们的使用策略可能不完全相同。因此，您有必要研究它们的具体策略以及它们与 Gentoo 的区别。

SLOT

此变量用于设置包的 SLOT，以便多个版本的包可以共存。默认情况下，应将 SLOT 设置为 "0"。如果您不确定，请在寻求专家指导之前不要修改此值。此值绝不应留空。

从 EAPI 5 开始，SLOT 变量可以包含一个可选的子槽部分，该部分位于常规槽之后，并以 / 字符分隔。子槽必须是有效的槽名称。子槽用于表示以下情况：将包升级到具有不同子槽的新版本可能需要重新构建依赖包。当 SLOT 定义中省略子槽部分时，该包被视为具有一个隐式子槽，该子槽等于常规槽。有关子槽用法的更多信息，请参阅 Atom Slot Operators 部分。

LICENSE

此变量应包含一个空格分隔的许可证列表，表示该包适用的许可证。此变量 _必须_ 设置为 /var/db/repos/gentoo/licenses/ 中存在的匹配许可证。如果存储库中尚不存在该许可证，则必须先添加它。

IUSE

此变量应包含构建脚本中使用到的所有 USE 标记的列表。此处不应列出的唯一 USE 标记是与架构相关的标记（请参阅 KEYWORDS）。从 EAPI 1 开始，可以在标记前添加 + 或 - 以创建分别启用或禁用相应 USE 标记的默认设置。有关 USE 标记堆叠顺序的详细信息，请参阅 make.conf(5) 中的 USE_ORDER 变量。鉴于默认的 USE_ORDER 设置，负 IUSE 默认设置仅对否定存储库级别的 USE 设置有效，因为配置文件和用户配置设置会覆盖它们。

DEPEND

此变量应包含程序编译（也称为构建时 依赖项）所需的所有包的列表。这些通常是库和头文件。

从 EAPI 7 开始，工具应放在 BDEPEND 变量中，因为 DEPEND 仅会安装到正在构建的系统中，因此在交叉编译时无法执行。