commit: 6097f10a39943b588d21a63e0a166fcebc0e4b9c
Author: Ben Kohler <bkohler <AT> gentoo <DOT> org>
AuthorDate: Fri Sep 6 16:30:36 2019 +0000
Commit: Ben Kohler <bkohler <AT> gentoo <DOT> org>
CommitDate: Tue Mar 31 14:54:33 2020 +0000
URL: https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=6097f10a
linux-info.eclass: minor @USAGE syntax fixes
Use the recommended <required args> [optional args] syntax
Signed-off-by: Ben Kohler <bkohler <AT> gentoo.org>
eclass/linux-info.eclass | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/eclass/linux-info.eclass b/eclass/linux-info.eclass
index 98ec0ac8dab..44eebcf52a9 100644
--- a/eclass/linux-info.eclass
+++ b/eclass/linux-info.eclass
@@ -159,7 +159,7 @@ qeerror() { qout eerror "${@}" ; }
# ---------------------------------------
# @FUNCTION: getfilevar
-# @USAGE: variable configfile
+# @USAGE: <variable> <configfile>
# @RETURN: the value of the variable
# @DESCRIPTION:
# It detects the value of the variable defined in the file configfile. This is
@@ -195,7 +195,7 @@ getfilevar() {
}
# @FUNCTION: getfilevar_noexec
-# @USAGE: variable configfile
+# @USAGE: <variable> <configfile>
# @RETURN: the value of the variable
# @DESCRIPTION:
# It detects the value of the variable defined in the file configfile.
@@ -310,7 +310,7 @@ require_configured_kernel() {
}
# @FUNCTION: linux_chkconfig_present
-# @USAGE: option
+# @USAGE: <option>
# @RETURN: true or false
# @DESCRIPTION:
# It checks that CONFIG_<option>=y or CONFIG_<option>=m is present in the
current kernel .config
@@ -322,7 +322,7 @@ linux_chkconfig_present() {
}
# @FUNCTION: linux_chkconfig_module
-# @USAGE: option
+# @USAGE: <option>
# @RETURN: true or false
# @DESCRIPTION:
# It checks that CONFIG_<option>=m is present in the current kernel .config
@@ -334,7 +334,7 @@ linux_chkconfig_module() {
}
# @FUNCTION: linux_chkconfig_builtin
-# @USAGE: option
+# @USAGE: <option>
# @RETURN: true or false
# @DESCRIPTION:
# It checks that CONFIG_<option>=y is present in the current kernel .config
@@ -346,7 +346,7 @@ linux_chkconfig_builtin() {
}
# @FUNCTION: linux_chkconfig_string
-# @USAGE: option
+# @USAGE: <option>
# @RETURN: CONFIG_<option>
# @DESCRIPTION:
# It prints the CONFIG_<option> value of the current kernel .config (it
requires a configured kernel).
@@ -361,7 +361,7 @@ linux_chkconfig_string() {
# ---------------------------------------
# @FUNCTION: kernel_is
-# @USAGE: [-lt -gt -le -ge -eq] major_number [minor_number patch_number]
+# @USAGE: [-lt -gt -le -ge -eq] <major_number> [minor_number patch_number]
# @RETURN: true or false
# @DESCRIPTION:
# It returns true when the current kernel version satisfies the comparison
against the passed version.
