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