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