Document functions which did not have any
documentation or was not formatted to gentoo
specifications
Signed-off-by: Mike Pagano <mpagano@gentoo.org>
---
eclass/linux-info.eclass | 38 ++++++++++++++++++++++++++++++++++----
1 file changed, 34 insertions(+), 4 deletions(-)
diff --git a/eclass/linux-info.eclass b/eclass/linux-info.eclass
index d2003874d..a61ba0153 100644
--- a/eclass/linux-info.eclass
+++ b/eclass/linux-info.eclass
@@ -169,9 +169,9 @@ set_arch_to_portage() {
# Set the env ARCH to match what the package manager expects.
set_arch_to_pkgmgr() { export ARCH=$(tc-arch); }
-# qeinfo "Message"
-# -------------------
-# qeinfo is a quiet einfo call when EBUILD_PHASE
+# @FUNCTION: qout
+# @DESCRIPTION:
+# qout <einfo | ewarn | eerror> is a quiet call when EBUILD_PHASE
# should not have visible output.
qout() {
local outputmsg type
@@ -186,8 +186,22 @@ qout() {
[ -n "${outputmsg}" ] && ${type} "${outputmsg}"
}
+# @FUNCTION: qeinfo
+# @DESCRIPTION:
+# qeinfo is a quiet einfo call when EBUILD_PHASE
+# should not have visible output.
qeinfo() { qout einfo "${@}" ; }
+
+# @FUNCTION: qewarn
+# @DESCRIPTION:
+# qewarn is a quiet ewarn call when EBUILD_PHASE
+# should not have visible output.
qewarn() { qout ewarn "${@}" ; }
+
+# @FUNCTION: qeerror
+# @DESCRIPTION:
+# qeerror is a quiet error call when EBUILD_PHASE
+# should not have visible output.
qeerror() { qout eerror "${@}" ; }
# File Functions
@@ -269,6 +283,11 @@ getfilevar_noexec() {
# config is available at all.
_LINUX_CONFIG_EXISTS_DONE=
+# @FUNCTION: linux_config_qa_check
+# @INTERNAL
+# @DESCRIPTION:
+# Helper funciton which returns an error before the function argument is run
+# if no config exists
linux_config_qa_check() {
local f="$1"
if [ -z "${_LINUX_CONFIG_EXISTS_DONE}" ]; then
@@ -438,6 +457,9 @@ kernel_is() {
"${1:-${KV_MAJOR:-0}}.${2:-${KV_MINOR:-0}}.${3:-${KV_PATCH:-0}}"
}
+# @FUNCTION: get_makefile_extract_function
+# @INTERNAL
+# @DESCRIPTION:
# Check if the Makefile is valid for direct parsing.
# Check status results:
# - PASS, use 'getfilevar' to extract values
@@ -453,7 +475,10 @@ get_makefile_extract_function() {
echo "${mkfunc}"
}
-# internal variable, so we know to only print the warning once
+# @ECLASS_VARIABLE: get_version_warning_done
+# @INTERNAL
+# @DESCRIPTION:
+# Internal variable to ensure we print a message only once
get_version_warning_done=
# @FUNCTION: get_version
@@ -870,6 +895,11 @@ check_extra_config() {
export LINUX_CONFIG_EXISTS_DONE="${old_LINUX_CONFIG_EXISTS_DONE}"
}
+# @FUNCTION: check_zlibinflate
+# @DESCRIPTION:
+# helper function to make sure a ZLIB_INFLATE configuration
+# has the requried symbols
+# See https://bugs.gentoo.org/27882
check_zlibinflate() {
if ! use kernel_linux; then
die "${FUNCNAME}() called on non-Linux system, please fix the ebuild"
--
2.35.1
documentation or was not formatted to gentoo
specifications
Signed-off-by: Mike Pagano <mpagano@gentoo.org>
---
eclass/linux-info.eclass | 38 ++++++++++++++++++++++++++++++++++----
1 file changed, 34 insertions(+), 4 deletions(-)
diff --git a/eclass/linux-info.eclass b/eclass/linux-info.eclass
index d2003874d..a61ba0153 100644
--- a/eclass/linux-info.eclass
+++ b/eclass/linux-info.eclass
@@ -169,9 +169,9 @@ set_arch_to_portage() {
# Set the env ARCH to match what the package manager expects.
set_arch_to_pkgmgr() { export ARCH=$(tc-arch); }
-# qeinfo "Message"
-# -------------------
-# qeinfo is a quiet einfo call when EBUILD_PHASE
+# @FUNCTION: qout
+# @DESCRIPTION:
+# qout <einfo | ewarn | eerror> is a quiet call when EBUILD_PHASE
# should not have visible output.
qout() {
local outputmsg type
@@ -186,8 +186,22 @@ qout() {
[ -n "${outputmsg}" ] && ${type} "${outputmsg}"
}
+# @FUNCTION: qeinfo
+# @DESCRIPTION:
+# qeinfo is a quiet einfo call when EBUILD_PHASE
+# should not have visible output.
qeinfo() { qout einfo "${@}" ; }
+
+# @FUNCTION: qewarn
+# @DESCRIPTION:
+# qewarn is a quiet ewarn call when EBUILD_PHASE
+# should not have visible output.
qewarn() { qout ewarn "${@}" ; }
+
+# @FUNCTION: qeerror
+# @DESCRIPTION:
+# qeerror is a quiet error call when EBUILD_PHASE
+# should not have visible output.
qeerror() { qout eerror "${@}" ; }
# File Functions
@@ -269,6 +283,11 @@ getfilevar_noexec() {
# config is available at all.
_LINUX_CONFIG_EXISTS_DONE=
+# @FUNCTION: linux_config_qa_check
+# @INTERNAL
+# @DESCRIPTION:
+# Helper funciton which returns an error before the function argument is run
+# if no config exists
linux_config_qa_check() {
local f="$1"
if [ -z "${_LINUX_CONFIG_EXISTS_DONE}" ]; then
@@ -438,6 +457,9 @@ kernel_is() {
"${1:-${KV_MAJOR:-0}}.${2:-${KV_MINOR:-0}}.${3:-${KV_PATCH:-0}}"
}
+# @FUNCTION: get_makefile_extract_function
+# @INTERNAL
+# @DESCRIPTION:
# Check if the Makefile is valid for direct parsing.
# Check status results:
# - PASS, use 'getfilevar' to extract values
@@ -453,7 +475,10 @@ get_makefile_extract_function() {
echo "${mkfunc}"
}
-# internal variable, so we know to only print the warning once
+# @ECLASS_VARIABLE: get_version_warning_done
+# @INTERNAL
+# @DESCRIPTION:
+# Internal variable to ensure we print a message only once
get_version_warning_done=
# @FUNCTION: get_version
@@ -870,6 +895,11 @@ check_extra_config() {
export LINUX_CONFIG_EXISTS_DONE="${old_LINUX_CONFIG_EXISTS_DONE}"
}
+# @FUNCTION: check_zlibinflate
+# @DESCRIPTION:
+# helper function to make sure a ZLIB_INFLATE configuration
+# has the requried symbols
+# See https://bugs.gentoo.org/27882
check_zlibinflate() {
if ! use kernel_linux; then
die "${FUNCNAME}() called on non-Linux system, please fix the ebuild"
--
2.35.1