Gentoo Archives: gentoo-dev

From: "Ulrich Müller" <ulm@g.o>
To: gentoo-dev@l.g.o
Subject: [gentoo-dev] [PATCH] eutils.eclass: Update function documentation.
Date: Sat, 20 Jan 2018 11:51:55
Message-Id: 23139.11599.686354.82745@a1i15.kph.uni-mainz.de
1 Mention that einstalldocs() and in_iuse() are provided by the package
2 manager in EAPI 6.
3
4 in_iuse "must not" (rather than "should not") be used in global scope.
5 ---
6 eclass/eutils.eclass | 17 ++++++++++-------
7 1 file changed, 10 insertions(+), 7 deletions(-)
8
9 diff --git a/eclass/eutils.eclass b/eclass/eutils.eclass
10 index be8251f5794a..8bbd561015ad 100644
11 --- a/eclass/eutils.eclass
12 +++ b/eclass/eutils.eclass
13 @@ -362,12 +362,14 @@ case ${EAPI:-0} in
14
15 # @FUNCTION: einstalldocs
16 # @DESCRIPTION:
17 -# Install documentation using DOCS and HTML_DOCS.
18 +# Install documentation using DOCS and HTML_DOCS, in EAPIs that do not
19 +# provide this function. When available (i.e., in EAPI 6 or later),
20 +# the package manager implementation should be used instead.
21 #
22 # If DOCS is declared and non-empty, all files listed in it are
23 -# installed. The files must exist, otherwise the function will fail.
24 -# In EAPI 4 and subsequent EAPIs DOCS may specify directories as well,
25 -# in other EAPIs using directories is unsupported.
26 +# installed. The files must exist, otherwise the function will fail.
27 +# In EAPI 4 and 5, DOCS may specify directories as well; in earlier
28 +# EAPIs using directories is unsupported.
29 #
30 # If DOCS is not declared, the files matching patterns given
31 # in the default EAPI implementation of src_install will be installed.
32 @@ -424,10 +426,11 @@ einstalldocs() {
33 # @FUNCTION: in_iuse
34 # @USAGE: <flag>
35 # @DESCRIPTION:
36 -# Determines whether the given flag is in IUSE. Strips IUSE default prefixes
37 -# as necessary.
38 +# Determines whether the given flag is in IUSE. Strips IUSE default
39 +# prefixes as necessary. In EAPIs where it is available (i.e., EAPI 6
40 +# or later), the package manager implementation should be used instead.
41 #
42 -# Note that this function should not be used in the global scope.
43 +# Note that this function must not be used in the global scope.
44 in_iuse() {
45 debug-print-function ${FUNCNAME} "${@}"
46 [[ ${#} -eq 1 ]] || die "Invalid args to ${FUNCNAME}()"
47 --
48 2.16.0