Gentoo Archives: gentoo-dev

From: Mike Pagano <mpagano@g.o>
To: gentoo-dev@l.g.o
Subject: [gentoo-dev] [PATCH] linux-mod.eclass : Fix eclassdoc problems
Date: Fri, 27 Aug 2021 13:00:24
Message-Id: b7163759-752d-b7e0-89d8-b3b9ee35a6a4@gentoo.org
1 linux-mod.eclass : Fix eclassdoc problems
2
3 Bug: https://bugs.gentoo.org/637782
4
5 Signed-off-by: Mike Pagano <mpagano@g.o>
6 ---
7 eclass/linux-mod.eclass | 13 +++++++++++++
8 1 file changed, 13 insertions(+)
9
10 diff --git a/eclass/linux-mod.eclass b/eclass/linux-mod.eclass
11 index 7e47a2e20..eda5e9aee 100644
12 --- a/eclass/linux-mod.eclass
13 +++ b/eclass/linux-mod.eclass
14 @@ -20,12 +20,14 @@
15
16 # @ECLASS-VARIABLE: MODULES_OPTIONAL_USE
17 # @PRE_INHERIT
18 +# @DEFAULT_UNSET
19 # @DESCRIPTION:Cc: mpagano@g.o
20
21 # A string containing the USE flag to use for making this eclass optional
22 # The recommended non-empty value is 'modules'
23
24 # @ECLASS-VARIABLE: MODULES_OPTIONAL_USE_IUSE_DEFAULT
25 # @PRE_INHERIT
26 +# @DEFAULT_UNSET
27 # @DESCRIPTION:
28 # A boolean to control the IUSE default state for the MODULES_OPTIONAL_USE USE
29 # flag. Default value is unset (false). True represented by 1 or 'on', other
30 @@ -35,21 +37,26 @@
31 # @DESCRIPTION:
32 # A string containing the directory of the target kernel sources. The default value is
33 # "/usr/src/linux"
34 +: ${KERNEL_DIR:=/usr/src/linux}
35
36 # @ECLASS-VARIABLE: ECONF_PARAMS
37 +# @DEFAULT_UNSET
38 # @DESCRIPTION:
39 # It's a string containing the parameters to pass to econf.
40 # If this is not set, then econf isn't run.
41
42 # @ECLASS-VARIABLE: BUILD_PARAMS
43 +# @DEFAULT_UNSET
44 # @DESCRIPTION:
45 # It's a string with the parameters to pass to emake.
46
47 # @ECLASS-VARIABLE: BUILD_TARGETS
48 # @DESCRIPTION:
49 # It's a string with the build targets to pass to make. The default value is "clean module"
50 +: ${BUILD_TARGETS:=clean module}
51
52 # @ECLASS-VARIABLE: MODULE_NAMES
53 +# @DEFAULT_UNSET
54 # @DESCRIPTION:
55 # It's a string containing the modules to be built automatically using the default
56 # src_compile/src_install. It will only make ${BUILD_TARGETS} once in any directory.
57 @@ -94,12 +101,14 @@
58 # This can be explicitly enabled by setting any of the following variables.
59
60 # @ECLASS-VARIABLE: MODULESD_<modulename>_ENABLED
61 +# @DEFAULT_UNSET
62 # @DESCRIPTION:
63 # This is used to disable the modprobe.d file generation otherwise the file will be
64 # always generated (unless no MODULESD_<modulename>_* variable is provided). Set to "no" to disable
65 # the generation of the file and the installation of the documentation.
66
67 # @ECLASS-VARIABLE: MODULESD_<modulename>_EXAMPLES
68 +# @DEFAULT_UNSET
69 # @DESCRIPTION:
70 # This is a bash array containing a list of examples which should
71 # be used. If you want us to try and take a guess set this to "guess".
72 @@ -111,6 +120,7 @@
73 # where array_component is "<modulename> options" (see modprobe.conf(5))
74
75 # @ECLASS-VARIABLE: MODULESD_<modulename>_ALIASES
76 +# @DEFAULT_UNSET
77 # @DESCRIPTION:
78 # This is a bash array containing a list of associated aliases.
79 #
80 @@ -121,17 +131,20 @@
81 # where array_component is "wildcard <modulename>" (see modprobe.conf(5))
82
83 # @ECLASS-VARIABLE: MODULESD_<modulename>_ADDITIONS
84 +# @DEFAULT_UNSET
85 # @DESCRIPTION:
86 # This is a bash array containing a list of additional things to
87 # add to the bottom of the file. This can be absolutely anything.
88 # Each entry is a new line.
89
90 # @ECLASS-VARIABLE: MODULESD_<modulename>_DOCS
91 +# @DEFAULT_UNSET
92 # @DESCRIPTION:
93 # This is a string list which contains the full path to any associated
94 # documents for <modulename>. These files are installed in the live tree.
95
96 # @ECLASS-VARIABLE: KV_OBJ
97 +# @INTERNAL
98 # @DESCRIPTION:
99 # It's a read-only variable. It contains the extension of the kernel modules.
100
101 --
102 2.31.1