[gentoo-commits] repo/gentoo:master commit in: eclass/

[Sam James]

commit:     7f33a4d20fa0dc82c6e82c027e6d536a77a4d278
Author:     Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Fri Mar 18 01:18:21 2022 +0000
Commit:     Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Fri Mar 25 19:47:40 2022 +0000
URL:        https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=7f33a4d2

multilib.eclass: document multilib_env

Signed-off-by: Sam James <sam <AT> gentoo.org>

 eclass/multilib.eclass | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/eclass/multilib.eclass b/eclass/multilib.eclass
index fadd371f3ca7..ec2676cb6cfb 100644
--- a/eclass/multilib.eclass
+++ b/eclass/multilib.eclass
@@ -1,4 +1,4 @@
-# Copyright 1999-2021 Gentoo Authors
+# Copyright 1999-2022 Gentoo Authors
 # Distributed under the terms of the GNU General Public License v2
 
 # @ECLASS: multilib.eclass
@@ -299,8 +299,13 @@ get_modname() {
        echo ".${modname}"
 }
 
+# @FUNCTION: multilib_env
+# @USAGE:
+# @DESCRIPTION:
 # This is for the toolchain to setup profile variables when pulling in
 # a crosscompiler (and thus they aren't set in the profile).
+#
+# This must only be used by toolchain packages.
 multilib_env() {
        local CTARGET=${1:-${CTARGET}}
        local cpu=${CTARGET%%*-}