Ebuild-defined Variables
Ebuild-defined Variables
The following variables may or must be defined by every ebuild.
| Variable | Purpose |
|---|---|
| EAPI | The EAPI. See EAPI Usage and Description. |
| DESCRIPTION | A short (not more than 80 characters) description of the package's purpose. Mandatory. |
| HOMEPAGE | Package's homepage(s). Mandatory (except for virtuals), accepts multiple values. In some contexts, it is customary to provide package tracker and/or code hosting links besides the main homepage (e.g. PyPI link for Python packages, GitHub link when code can't easily be found on homepage) for convenience. If no homepage for the package is available, please set it to https://wiki.gentoo.org/wiki/No_homepage. Never refer to a variable name in the string; include only raw text. |
| SRC_URI | A list of source URIs for the package. Can contain USE-conditional parts, see SRC_URI. |
| LICENSE | The package's license, corresponding exactly (including case) to a file in licenses/. Mandatory (except for virtuals). See LICENSE. |
| SLOT | The package's SLOT. Mandatory. See SLOT. |
| KEYWORDS | See KEYWORDS and Keywording and Stabilization. |
| IUSE | A list of all USE flags (excluding arch flags, but including USE_EXPAND flags) used within the ebuild. See IUSE. |
| REQUIRED_USE | A list of assertions that must be met by the configuration of USE flags to be valid for this ebuild. See REQUIRED_USE. |
| PROPERTIES | A space-delimited list of properties, with conditional syntax support. interactive is the only valid value for now. |
| RESTRICT | A space-delimited list of portage features to restrict. Valid values are fetch, mirror, strip, test and userpriv. See man 5 ebuild for details. |
| DEPEND | A list of the package's build dependencies. See Dependencies. Starting with EAPI-7, applies to CHOST only. |
| BDEPEND | (EAPI=7) A list of the package's CBUILD build dependencies. See Dependencies. |
| RDEPEND | A list of the package's runtime dependencies. See Dependencies. |
| PDEPEND | A list of packages to be installed (if possible) after the package is merged. Use this only when RDEPEND would cause cyclic dependencies. See Dependencies. |
| S | Path to the temporary build directory, used by src_compile and src_install. Default: "${WORKDIR}/${P}". Ebuilds should not provide a value for this variable if it is the same as the default value. |
| DOCS | An array or whitespace-separated list of documentation files for the default src_install function to install using dodoc. If undefined, a reasonable default list is used. See the default src_install function. |
| HTML_DOCS | An array or space-delimited list of documentation files or directories for the einstalldocs function to install recursively. (Requires EAPI>=6.) |