1 |
commit: 9ac3350618058e3e6838a56e68f98c1922b8d57a |
2 |
Author: Mike Pagano <mpagano <AT> gentoo <DOT> org> |
3 |
AuthorDate: Mon May 16 22:55:45 2022 +0000 |
4 |
Commit: Mike Pagano <mpagano <AT> gentoo <DOT> org> |
5 |
CommitDate: Mon May 16 22:55:45 2022 +0000 |
6 |
URL: https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=9ac33506 |
7 |
|
8 |
linux-info.eclass: Documentation updates |
9 |
|
10 |
Signed-off-by: Mike Pagano <mpagano <AT> gentoo.org> |
11 |
|
12 |
eclass/linux-info.eclass | 35 ++++++++++++++++++++++++++++++----- |
13 |
1 file changed, 30 insertions(+), 5 deletions(-) |
14 |
|
15 |
diff --git a/eclass/linux-info.eclass b/eclass/linux-info.eclass |
16 |
index d2003874da09..7e130062a6c1 100644 |
17 |
--- a/eclass/linux-info.eclass |
18 |
+++ b/eclass/linux-info.eclass |
19 |
@@ -169,10 +169,9 @@ set_arch_to_portage() { |
20 |
# Set the env ARCH to match what the package manager expects. |
21 |
set_arch_to_pkgmgr() { export ARCH=$(tc-arch); } |
22 |
|
23 |
-# qeinfo "Message" |
24 |
-# ------------------- |
25 |
-# qeinfo is a quiet einfo call when EBUILD_PHASE |
26 |
-# should not have visible output. |
27 |
+# @FUNCTION: qout |
28 |
+# @DESCRIPTION: |
29 |
+# qout <einfo | ewarn | eerror> is a quiet call when EBUILD_PHASE should not have visible output. |
30 |
qout() { |
31 |
local outputmsg type |
32 |
type=${1} |
33 |
@@ -186,8 +185,21 @@ qout() { |
34 |
[ -n "${outputmsg}" ] && ${type} "${outputmsg}" |
35 |
} |
36 |
|
37 |
+# @FUNCTION: qeinfo |
38 |
+# @DESCRIPTION: |
39 |
+# qeinfo is a quiet einfo call when EBUILD_PHASE should not have visible output. |
40 |
qeinfo() { qout einfo "${@}" ; } |
41 |
+ |
42 |
+# @FUNCTION: qewarn |
43 |
+# @DESCRIPTION: |
44 |
+# qewarn is a quiet ewarn call when EBUILD_PHASE |
45 |
+# should not have visible output. |
46 |
qewarn() { qout ewarn "${@}" ; } |
47 |
+ |
48 |
+# @FUNCTION: qeerror |
49 |
+# @DESCRIPTION: |
50 |
+# qeerror is a quiet error call when EBUILD_PHASE |
51 |
+# should not have visible output. |
52 |
qeerror() { qout eerror "${@}" ; } |
53 |
|
54 |
# File Functions |
55 |
@@ -269,6 +281,10 @@ getfilevar_noexec() { |
56 |
# config is available at all. |
57 |
_LINUX_CONFIG_EXISTS_DONE= |
58 |
|
59 |
+# @FUNCTION: linux_config_qa_check |
60 |
+# @INTERNAL |
61 |
+# @DESCRIPTION: |
62 |
+# Helper funciton which returns an error before the function argument is run if no config exists |
63 |
linux_config_qa_check() { |
64 |
local f="$1" |
65 |
if [ -z "${_LINUX_CONFIG_EXISTS_DONE}" ]; then |
66 |
@@ -438,6 +454,9 @@ kernel_is() { |
67 |
"${1:-${KV_MAJOR:-0}}.${2:-${KV_MINOR:-0}}.${3:-${KV_PATCH:-0}}" |
68 |
} |
69 |
|
70 |
+# @FUNCTION: get_makefile_extract_function |
71 |
+# @INTERNAL |
72 |
+# @DESCRIPTION: |
73 |
# Check if the Makefile is valid for direct parsing. |
74 |
# Check status results: |
75 |
# - PASS, use 'getfilevar' to extract values |
76 |
@@ -453,7 +472,10 @@ get_makefile_extract_function() { |
77 |
echo "${mkfunc}" |
78 |
} |
79 |
|
80 |
-# internal variable, so we know to only print the warning once |
81 |
+# @ECLASS_VARIABLE: get_version_warning_done |
82 |
+# @INTERNAL |
83 |
+# @DESCRIPTION: |
84 |
+# Internal variable, so we know to only print the warning once. |
85 |
get_version_warning_done= |
86 |
|
87 |
# @FUNCTION: get_version |
88 |
@@ -870,6 +892,9 @@ check_extra_config() { |
89 |
export LINUX_CONFIG_EXISTS_DONE="${old_LINUX_CONFIG_EXISTS_DONE}" |
90 |
} |
91 |
|
92 |
+# @FUNCTION: check_zlibinflate |
93 |
+# @DESCRIPTION: |
94 |
+# Function to make sure a ZLIB_INFLATE configuration has the required symbols. |
95 |
check_zlibinflate() { |
96 |
if ! use kernel_linux; then |
97 |
die "${FUNCNAME}() called on non-Linux system, please fix the ebuild" |