1 |
commit: 5d1440912c5b39f20dfb938fee1fedae125440ba |
2 |
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org> |
3 |
AuthorDate: Sat Jan 20 11:46:01 2018 +0000 |
4 |
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org> |
5 |
CommitDate: Mon Jan 29 07:08:26 2018 +0000 |
6 |
URL: https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=5d144091 |
7 |
|
8 |
eutils.eclass: Update function documentation. |
9 |
|
10 |
Mention that einstalldocs() and in_iuse() are provided by the package |
11 |
manager in EAPI 6. |
12 |
|
13 |
in_iuse "must not" (rather than "should not") be used in global scope. |
14 |
|
15 |
eclass/eutils.eclass | 17 ++++++++++------- |
16 |
1 file changed, 10 insertions(+), 7 deletions(-) |
17 |
|
18 |
diff --git a/eclass/eutils.eclass b/eclass/eutils.eclass |
19 |
index be8251f5794..8bbd561015a 100644 |
20 |
--- a/eclass/eutils.eclass |
21 |
+++ b/eclass/eutils.eclass |
22 |
@@ -362,12 +362,14 @@ case ${EAPI:-0} in |
23 |
|
24 |
# @FUNCTION: einstalldocs |
25 |
# @DESCRIPTION: |
26 |
-# Install documentation using DOCS and HTML_DOCS. |
27 |
+# Install documentation using DOCS and HTML_DOCS, in EAPIs that do not |
28 |
+# provide this function. When available (i.e., in EAPI 6 or later), |
29 |
+# the package manager implementation should be used instead. |
30 |
# |
31 |
# If DOCS is declared and non-empty, all files listed in it are |
32 |
-# installed. The files must exist, otherwise the function will fail. |
33 |
-# In EAPI 4 and subsequent EAPIs DOCS may specify directories as well, |
34 |
-# in other EAPIs using directories is unsupported. |
35 |
+# installed. The files must exist, otherwise the function will fail. |
36 |
+# In EAPI 4 and 5, DOCS may specify directories as well; in earlier |
37 |
+# EAPIs using directories is unsupported. |
38 |
# |
39 |
# If DOCS is not declared, the files matching patterns given |
40 |
# in the default EAPI implementation of src_install will be installed. |
41 |
@@ -424,10 +426,11 @@ einstalldocs() { |
42 |
# @FUNCTION: in_iuse |
43 |
# @USAGE: <flag> |
44 |
# @DESCRIPTION: |
45 |
-# Determines whether the given flag is in IUSE. Strips IUSE default prefixes |
46 |
-# as necessary. |
47 |
+# Determines whether the given flag is in IUSE. Strips IUSE default |
48 |
+# prefixes as necessary. In EAPIs where it is available (i.e., EAPI 6 |
49 |
+# or later), the package manager implementation should be used instead. |
50 |
# |
51 |
-# Note that this function should not be used in the global scope. |
52 |
+# Note that this function must not be used in the global scope. |
53 |
in_iuse() { |
54 |
debug-print-function ${FUNCNAME} "${@}" |
55 |
[[ ${#} -eq 1 ]] || die "Invalid args to ${FUNCNAME}()" |