From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id BB3581581F0 for ; Sat, 18 Jan 2025 10:18:43 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 0D001E0839; Sat, 18 Jan 2025 10:18:43 +0000 (UTC) Received: from smtp.gentoo.org (woodpecker.gentoo.org [140.211.166.183]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id DE05CE0839 for ; Sat, 18 Jan 2025 10:18:42 +0000 (UTC) Received: from oystercatcher.gentoo.org (oystercatcher.gentoo.org [148.251.78.52]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id E96BD342F8D for ; Sat, 18 Jan 2025 10:18:41 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id 4EB87252F for ; Sat, 18 Jan 2025 10:18:39 +0000 (UTC) From: "Ulrich Müller" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Ulrich Müller" Message-ID: <1737139240.826681e69791946e9dd7c8e3b669c6c89db5fb45.ulm@gentoo> Subject: [gentoo-commits] proj/pms:eapi-9 commit in: / X-VCS-Repository: proj/pms X-VCS-Files: ebuild-env-vars.tex ebuild-functions.tex ebuild-vars.tex X-VCS-Directories: / X-VCS-Committer: ulm X-VCS-Committer-Name: Ulrich Müller X-VCS-Revision: 826681e69791946e9dd7c8e3b669c6c89db5fb45 X-VCS-Branch: eapi-9 Date: Sat, 18 Jan 2025 10:18:39 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply X-Archives-Salt: b4476dc3-5d72-4476-ba90-0d537f0e0d75 X-Archives-Hash: 8fc4167db14a9545a8d9fa5e47c2183e commit: 826681e69791946e9dd7c8e3b669c6c89db5fb45 Author: Ulrich Müller gentoo org> AuthorDate: Tue Jan 7 17:09:52 2025 +0000 Commit: Ulrich Müller gentoo org> CommitDate: Fri Jan 17 18:40:40 2025 +0000 URL: https://gitweb.gentoo.org/proj/pms.git/commit/?id=826681e6 Clarify use of the terms "export" and "environment variable" Signed-off-by: Ulrich Müller gentoo.org> ebuild-env-vars.tex | 12 ++++++------ ebuild-functions.tex | 22 +++++++++++----------- ebuild-vars.tex | 4 ++-- 3 files changed, 19 insertions(+), 19 deletions(-) diff --git a/ebuild-env-vars.tex b/ebuild-env-vars.tex index 861dd48..268fa36 100644 --- a/ebuild-env-vars.tex +++ b/ebuild-env-vars.tex @@ -211,14 +211,14 @@ inconsistent variable. No & \featurelabel{desttree} Controls the location where \t{dobin}, \t{dolib}, \t{domo}, and \t{dosbin} install things. Only for EAPIs listed in table~\ref{tab:removed-env-vars-table} - as supporting \t{DESTTREE}\@. In all other EAPIs, this is retained as a conceptual variable not - exported to the ebuild environment. \\ + as supporting \t{DESTTREE}\@. In all other EAPIs, this is retained as a conceptual variable + inaccessible from the ebuild environment. \\ \t{INSDESTTREE} & \t{src_install} & No & \featurelabel{insdesttree} Controls the location where \t{doins} installs things. Only for EAPIs listed in table~\ref{tab:removed-env-vars-table} as supporting \t{INSDESTTREE}\@. In all other - EAPIs, this is retained as a conceptual variable not exported to the ebuild environment. \\ + EAPIs, this is retained as a conceptual variable inaccessible from the ebuild environment. \\ \t{USE} & All & Yes & @@ -373,11 +373,11 @@ This section discusses the handling of four variables: \begin{description} \item[IUSE] is the variable calculated from the \t{IUSE} values defined in ebuilds and eclasses. \item[IUSE_REFERENCEABLE] is a variable calculated from \t{IUSE} and a variety of other sources - described below. It is purely a conceptual variable; it is not exported to the ebuild + described below. It is purely a conceptual variable; it is inaccessible from the ebuild environment. Values in \t{IUSE_REFERENCEABLE} may legally be used in queries from other packages about an ebuild's state (for example, for use dependencies). -\item[IUSE_EFFECTIVE] is another conceptual, unexported variable. Values in \t{IUSE_EFFECTIVE} are - those which an ebuild may legally use in queries about itself (for example, for the \t{use} +\item[IUSE_EFFECTIVE] is another conceptual, inaccessible variable. Values in \t{IUSE_EFFECTIVE} + are those which an ebuild may legally use in queries about itself (for example, for the \t{use} function, and for use in dependency specification conditional blocks). \item[USE] is a variable calculated by the package manager and exported to the ebuild environment. \end{description} diff --git a/ebuild-functions.tex b/ebuild-functions.tex index 046a0a7..bf6b774 100644 --- a/ebuild-functions.tex +++ b/ebuild-functions.tex @@ -8,10 +8,10 @@ by the package manager as part of the build and/or install process. In all cases must provide a default implementation of these functions; unless otherwise stated this must be a no-op. All functions may assume that they have read access to all system libraries, binaries and configuration files that are accessible to normal users, as well as write access to the temporary -directories specified by the \t{T}, \t{TMPDIR} and \t{HOME} environment variables +directories specified by the \t{T}, \t{TMPDIR} and \t{HOME} variables (see section~\ref{sec:ebuild-env-vars}). Most functions must assume only that they have additional -write access to the package's working directory (the \t{WORKDIR} environment variable); exceptions -are noted below. +write access to the package's working directory (the \t{WORKDIR} variable); exceptions are noted +below. The environment for functions run outside of the build sequence (that is, \t{pkg_config}, \t{pkg_info}, \t{pkg_prerm} and \t{pkg_postrm}) must be the environment used for the build of the @@ -400,37 +400,37 @@ src_install() { The \t{pkg_preinst} function performs any special tasks that are required immediately before merging the package to the live filesystem. It must not write outside of the directories specified -by the \t{ROOT} and \t{D} environment variables. +by the \t{ROOT} and \t{D} variables. \t{pkg_preinst} must be run with full access to all files and directories below that specified by -the \t{ROOT} and \t{D} environment variables. +the \t{ROOT} and \t{D} variables. \subsection{pkg_postinst} The \t{pkg_postinst} function performs any special tasks that are required immediately after merging the package to the live filesystem. It must not write outside of the directory specified -in the \t{ROOT} environment variable. +in the \t{ROOT} variable. \t{pkg_postinst}, like, \t{pkg_preinst}, must be run with full access to all files and directories -below that specified by the \t{ROOT} environment variable. +below that specified by the \t{ROOT} variable. \subsection{pkg_prerm} The \t{pkg_prerm} function performs any special tasks that are required immediately before unmerging the package from the live filesystem. It must not write outside of the directory specified -by the \t{ROOT} environment variable. +by the \t{ROOT} variable. \t{pkg_prerm} must be run with full access to all files and directories below that specified by -the \t{ROOT} environment variable. +the \t{ROOT} variable. \subsection{pkg_postrm} The \t{pkg_postrm} function performs any special tasks that are required immediately after unmerging the package from the live filesystem. It must not write outside of the directory specified -by the \t{ROOT} environment variable. +by the \t{ROOT} variable. \t{pkg_postrm} must be run with full access to all files and directories below that specified by -the \t{ROOT} environment variable. +the \t{ROOT} variable. \subsection{pkg_config} diff --git a/ebuild-vars.tex b/ebuild-vars.tex index 561eb0c..b030943 100644 --- a/ebuild-vars.tex +++ b/ebuild-vars.tex @@ -305,8 +305,8 @@ considered to be part of the ebuild's metadata: \note{Thus, by extension of section~\ref{sec:metadata-invariance}, \t{inherit} may not be used conditionally, except upon constant conditions.} -The following are special variables defined by the package manager for internal use and may or may -not be exported to the ebuild environment: +The following is a special variable defined by the package manager for internal use and may or may +not be available in the ebuild environment: \begin{description} \item[DEFINED_PHASES] \featurelabel{defined-phases} A space separated arbitrarily ordered list