1 |
commit: 6097f10a39943b588d21a63e0a166fcebc0e4b9c |
2 |
Author: Ben Kohler <bkohler <AT> gentoo <DOT> org> |
3 |
AuthorDate: Fri Sep 6 16:30:36 2019 +0000 |
4 |
Commit: Ben Kohler <bkohler <AT> gentoo <DOT> org> |
5 |
CommitDate: Tue Mar 31 14:54:33 2020 +0000 |
6 |
URL: https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=6097f10a |
7 |
|
8 |
linux-info.eclass: minor @USAGE syntax fixes |
9 |
|
10 |
Use the recommended <required args> [optional args] syntax |
11 |
|
12 |
Signed-off-by: Ben Kohler <bkohler <AT> gentoo.org> |
13 |
|
14 |
eclass/linux-info.eclass | 14 +++++++------- |
15 |
1 file changed, 7 insertions(+), 7 deletions(-) |
16 |
|
17 |
diff --git a/eclass/linux-info.eclass b/eclass/linux-info.eclass |
18 |
index 98ec0ac8dab..44eebcf52a9 100644 |
19 |
--- a/eclass/linux-info.eclass |
20 |
+++ b/eclass/linux-info.eclass |
21 |
@@ -159,7 +159,7 @@ qeerror() { qout eerror "${@}" ; } |
22 |
# --------------------------------------- |
23 |
|
24 |
# @FUNCTION: getfilevar |
25 |
-# @USAGE: variable configfile |
26 |
+# @USAGE: <variable> <configfile> |
27 |
# @RETURN: the value of the variable |
28 |
# @DESCRIPTION: |
29 |
# It detects the value of the variable defined in the file configfile. This is |
30 |
@@ -195,7 +195,7 @@ getfilevar() { |
31 |
} |
32 |
|
33 |
# @FUNCTION: getfilevar_noexec |
34 |
-# @USAGE: variable configfile |
35 |
+# @USAGE: <variable> <configfile> |
36 |
# @RETURN: the value of the variable |
37 |
# @DESCRIPTION: |
38 |
# It detects the value of the variable defined in the file configfile. |
39 |
@@ -310,7 +310,7 @@ require_configured_kernel() { |
40 |
} |
41 |
|
42 |
# @FUNCTION: linux_chkconfig_present |
43 |
-# @USAGE: option |
44 |
+# @USAGE: <option> |
45 |
# @RETURN: true or false |
46 |
# @DESCRIPTION: |
47 |
# It checks that CONFIG_<option>=y or CONFIG_<option>=m is present in the current kernel .config |
48 |
@@ -322,7 +322,7 @@ linux_chkconfig_present() { |
49 |
} |
50 |
|
51 |
# @FUNCTION: linux_chkconfig_module |
52 |
-# @USAGE: option |
53 |
+# @USAGE: <option> |
54 |
# @RETURN: true or false |
55 |
# @DESCRIPTION: |
56 |
# It checks that CONFIG_<option>=m is present in the current kernel .config |
57 |
@@ -334,7 +334,7 @@ linux_chkconfig_module() { |
58 |
} |
59 |
|
60 |
# @FUNCTION: linux_chkconfig_builtin |
61 |
-# @USAGE: option |
62 |
+# @USAGE: <option> |
63 |
# @RETURN: true or false |
64 |
# @DESCRIPTION: |
65 |
# It checks that CONFIG_<option>=y is present in the current kernel .config |
66 |
@@ -346,7 +346,7 @@ linux_chkconfig_builtin() { |
67 |
} |
68 |
|
69 |
# @FUNCTION: linux_chkconfig_string |
70 |
-# @USAGE: option |
71 |
+# @USAGE: <option> |
72 |
# @RETURN: CONFIG_<option> |
73 |
# @DESCRIPTION: |
74 |
# It prints the CONFIG_<option> value of the current kernel .config (it requires a configured kernel). |
75 |
@@ -361,7 +361,7 @@ linux_chkconfig_string() { |
76 |
# --------------------------------------- |
77 |
|
78 |
# @FUNCTION: kernel_is |
79 |
-# @USAGE: [-lt -gt -le -ge -eq] major_number [minor_number patch_number] |
80 |
+# @USAGE: [-lt -gt -le -ge -eq] <major_number> [minor_number patch_number] |
81 |
# @RETURN: true or false |
82 |
# @DESCRIPTION: |
83 |
# It returns true when the current kernel version satisfies the comparison against the passed version. |