Document functions which did not have any documentation or were not formatted to gentoo specifications
Signed-off-by: Mike Pagano <mpag...@gentoo.org> --- eclass/linux-mod.eclass | 66 ++++++++++++++++++++--------------------- 1 file changed, 33 insertions(+), 33 deletions(-) diff --git a/eclass/linux-mod.eclass b/eclass/linux-mod.eclass index 93e93b44a..111067a42 100644 --- a/eclass/linux-mod.eclass +++ b/eclass/linux-mod.eclass @@ -227,11 +227,10 @@ convert_to_m() { fi }-# internal function
-# -# FUNCTION: update_depmod -# DESCRIPTION: -# It updates the modules.dep file for the current kernel. +# @FUNCTION: update_depmod +# @INTERNAL +# @DESCRIPTION: +# Updates the modules.dep file for the current kernel. update_depmod() { debug-print-function ${FUNCNAME} $*@@ -252,11 +251,10 @@ update_depmod() {
fi }-# internal function
-# -# FUNCTION: move_old_moduledb -# DESCRIPTION: -# It updates the location of the database used by the module-rebuild utility. +# @FUNCTION: move_old_moduledb +# @INTERNAL +# @DESCRIPTION: +# Updates the location of the database used by the module-rebuild utility. move_old_moduledb() { debug-print-function ${FUNCNAME} $*@@ -272,11 +270,10 @@ move_old_moduledb() {
fi }-# internal function
-# -# FUNCTION: update_moduledb -# DESCRIPTION: -# It adds the package to the /var/lib/module-rebuild/moduledb database used by the module-rebuild utility. +# @FUNCTION: update_moduledb +# @INTERNAL +# @DESCRIPTION: +# Adds the package to the /var/lib/module-rebuild/moduledb database used by the module-rebuild utility. update_moduledb() { debug-print-function ${FUNCNAME} $*@@ -294,12 +291,10 @@ update_moduledb() {
fi }-# internal function
-# -# FUNCTION: remove_moduledb -# DESCRIPTION: -# It removes the package from the /var/lib/module-rebuild/moduledb database used by -# the module-rebuild utility. +# @FUNCTION: remove_moduledb +# @INTERNAL +# @DESCRIPTION: +# Removes the package from the /var/lib/module-rebuild/moduledb database used by remove_moduledb() { debug-print-function ${FUNCNAME} $*@@ -329,6 +324,10 @@ set_kvobj() {
# einfo "Using KV_OBJ=${KV_OBJ}" }+# @FUNCTION: get-KERNEL_CC
+# @RETURN: Name of the C compiler. +# @DESCRIPTION: +# Return name of the C compiler while honoring variables defined in ebuilds. get-KERNEL_CC() { debug-print-function ${FUNCNAME} $*@@ -349,12 +348,11 @@ get-KERNEL_CC() {
echo "${kernel_cc}" }-# internal function
-# -# FUNCTION: -# USAGE: /path/to/the/modulename_without_extension -# RETURN: A file in /etc/modprobe.d -# DESCRIPTION: +# @FUNCTION: generate_modulesd +# @INTERNAL +# @USAGE: /path/to/the/modulename_without_extension +# @RETURN: A file in /etc/modprobe.d +# @DESCRIPTION: # This function will generate and install the neccessary modprobe.d file from the # information contained in the modules exported parms. # (see the variables MODULESD_<modulename>_ENABLED, MODULESD_<modulename>_EXAMPLES, @@ -503,12 +501,11 @@ generate_modulesd() { return 0 }-# internal function
-# -# FUNCTION: find_module_params -# USAGE: A string "NAME(LIBDIR:SRCDIR:OBJDIR)" -# RETURN: The string "modulename:NAME libdir:LIBDIR srcdir:SRCDIR objdir:OBJDIR" -# DESCRIPTION: +# @FUNCTION: find_module_params +# @USAGE: A string "NAME(LIBDIR:SRCDIR:OBJDIR)" +# @INTERNAL +# @RETURN: The string "modulename:NAME libdir:LIBDIR srcdir:SRCDIR objdir:OBJDIR" +# @DESCRIPTION: # Analyze the specification NAME(LIBDIR:SRCDIR:OBJDIR) of one module as described in MODULE_NAMES. find_module_params() { debug-print-function ${FUNCNAME} $* @@ -601,6 +598,9 @@ linux-mod_pkg_setup_binary() { linux-info_pkg_setup; }+# @FUNCTION: strip_modulenames
+# @DESCRIPTION: +# Remove modules from being built automatically using the default src_compile/src_install strip_modulenames() { debug-print-function ${FUNCNAME} $*--
2.35.1
OpenPGP_0x92A6DBEC81F2B137.asc
Description: OpenPGP public key
OpenPGP_signature
Description: OpenPGP digital signature