1 ================================= !! 1 ===================
2 Configuration targets and editors !! 2 Kconfig make config
3 ================================= !! 3 ===================
4 4
5 This file contains some assistance for using ` !! 5 This file contains some assistance for using `make *config`.
6 6
7 Use ``make help`` to list all of the possible !! 7 Use "make help" to list all of the possible configuration targets.
8 8
9 The xconfig ('qconf'), menuconfig ('mconf'), a 9 The xconfig ('qconf'), menuconfig ('mconf'), and nconfig ('nconf')
10 programs also have embedded help text. Be sur 10 programs also have embedded help text. Be sure to check that for
11 navigation, search, and other general help tex 11 navigation, search, and other general help text.
12 12
13 The gconfig ('gconf') program has limited help <<
14 <<
15 <<
16 General 13 General
17 ======= !! 14 -------
18 15
19 New kernel releases often introduce new config 16 New kernel releases often introduce new config symbols. Often more
20 important, new kernel releases may rename conf 17 important, new kernel releases may rename config symbols. When
21 this happens, using a previously working .conf 18 this happens, using a previously working .config file and running
22 "make oldconfig" won't necessarily produce a w 19 "make oldconfig" won't necessarily produce a working new kernel
23 for you, so you may find that you need to see 20 for you, so you may find that you need to see what NEW kernel
24 symbols have been introduced. 21 symbols have been introduced.
25 22
26 To see a list of new config symbols, use:: 23 To see a list of new config symbols, use::
27 24
28 cp user/some/old.config .config !! 25 cp user/some/old.config .config
29 make listnewconfig !! 26 make listnewconfig
30 27
31 and the config program will list any new symbo 28 and the config program will list any new symbols, one per line.
32 29
33 Alternatively, you can use the brute force met 30 Alternatively, you can use the brute force method::
34 31
35 make oldconfig !! 32 make oldconfig
36 scripts/diffconfig .config.old .config | l !! 33 scripts/diffconfig .config.old .config | less
37 <<
38 <<
39 Environment variables <<
40 ===================== <<
41 <<
42 Environment variables for ``*config``: <<
43 <<
44 ``KCONFIG_CONFIG`` <<
45 This environment variable can be used to s <<
46 file name to override the default name of <<
47 <<
48 ``KCONFIG_DEFCONFIG_LIST`` <<
49 This environment variable specifies a list <<
50 used as a base configuration in case the . <<
51 Entries in the list are separated with whi <<
52 the first one that exists is used. <<
53 <<
54 ``KCONFIG_OVERWRITECONFIG`` <<
55 If you set KCONFIG_OVERWRITECONFIG in the <<
56 break symlinks when .config is a symlink t <<
57 <<
58 ``KCONFIG_WARN_UNKNOWN_SYMBOLS`` <<
59 This environment variable makes Kconfig wa <<
60 symbols in the config input. <<
61 34
62 ``KCONFIG_WERROR`` !! 35 ----------------------------------------------------------------------
63 If set, Kconfig treats warnings as errors. <<
64 36
65 ``CONFIG_`` !! 37 Environment variables for `*config`
66 If you set ``CONFIG_`` in the environment, <<
67 with its value when saving the configurati <<
68 default, ``CONFIG_``. <<
69 38
70 Environment variables for ``{allyes/allmod/all !! 39 KCONFIG_CONFIG
>> 40 --------------
>> 41 This environment variable can be used to specify a default kernel config
>> 42 file name to override the default name of ".config".
>> 43
>> 44 KCONFIG_OVERWRITECONFIG
>> 45 -----------------------
>> 46 If you set KCONFIG_OVERWRITECONFIG in the environment, Kconfig will not
>> 47 break symlinks when .config is a symlink to somewhere else.
>> 48
>> 49 `CONFIG_`
>> 50 ---------
>> 51 If you set `CONFIG_` in the environment, Kconfig will prefix all symbols
>> 52 with its value when saving the configuration, instead of using the default,
>> 53 `CONFIG_`.
>> 54
>> 55 ----------------------------------------------------------------------
>> 56
>> 57 Environment variables for '{allyes/allmod/allno/rand}config'
>> 58
>> 59 KCONFIG_ALLCONFIG
>> 60 -----------------
>> 61 (partially based on lkml email from/by Rob Landley, re: miniconfig)
>> 62
>> 63 --------------------------------------------------
>> 64
>> 65 The allyesconfig/allmodconfig/allnoconfig/randconfig variants can also
>> 66 use the environment variable KCONFIG_ALLCONFIG as a flag or a filename
>> 67 that contains config symbols that the user requires to be set to a
>> 68 specific value. If KCONFIG_ALLCONFIG is used without a filename where
>> 69 KCONFIG_ALLCONFIG == "" or KCONFIG_ALLCONFIG == "1", `make *config`
>> 70 checks for a file named "all{yes/mod/no/def/random}.config"
>> 71 (corresponding to the `*config` command that was used) for symbol values
>> 72 that are to be forced. If this file is not found, it checks for a
>> 73 file named "all.config" to contain forced values.
>> 74
>> 75 This enables you to create "miniature" config (miniconfig) or custom
>> 76 config files containing just the config symbols that you are interested
>> 77 in. Then the kernel config system generates the full .config file,
>> 78 including symbols of your miniconfig file.
>> 79
>> 80 This 'KCONFIG_ALLCONFIG' file is a config file which contains
>> 81 (usually a subset of all) preset config symbols. These variable
>> 82 settings are still subject to normal dependency checks.
71 83
72 ``KCONFIG_ALLCONFIG`` !! 84 Examples::
73 The allyesconfig/allmodconfig/allnoconfig/ <<
74 use the environment variable KCONFIG_ALLCO <<
75 that contains config symbols that the user <<
76 specific value. If KCONFIG_ALLCONFIG is u <<
77 KCONFIG_ALLCONFIG == "" or KCONFIG_ALLCONF <<
78 checks for a file named "all{yes/mod/no/de <<
79 (corresponding to the ``*config`` command <<
80 that are to be forced. If this file is no <<
81 file named "all.config" to contain forced <<
82 <<
83 This enables you to create "miniature" con <<
84 config files containing just the config sy <<
85 in. Then the kernel config system generat <<
86 including symbols of your miniconfig file. <<
87 <<
88 This ``KCONFIG_ALLCONFIG`` file is a confi <<
89 (usually a subset of all) preset config sy <<
90 settings are still subject to normal depen <<
91 85
92 Examples:: !! 86 KCONFIG_ALLCONFIG=custom-notebook.config make allnoconfig
93 87
94 KCONFIG_ALLCONFIG=custom-notebook.conf !! 88 or::
95 89
96 or:: !! 90 KCONFIG_ALLCONFIG=mini.config make allnoconfig
97 91
98 KCONFIG_ALLCONFIG=mini.config make all !! 92 or::
99 93
100 or:: !! 94 make KCONFIG_ALLCONFIG=mini.config allnoconfig
101 95
102 make KCONFIG_ALLCONFIG=mini.config all !! 96 These examples will disable most options (allnoconfig) but enable or
>> 97 disable the options that are explicitly listed in the specified
>> 98 mini-config files.
103 99
104 These examples will disable most options ( !! 100 ----------------------------------------------------------------------
105 disable the options that are explicitly li <<
106 mini-config files. <<
107 101
108 Environment variables for ``randconfig``: !! 102 Environment variables for 'randconfig'
109 103
110 ``KCONFIG_SEED`` !! 104 KCONFIG_SEED
111 You can set this to the integer value used !! 105 ------------
112 to somehow debug the behaviour of the kcon !! 106 You can set this to the integer value used to seed the RNG, if you want
113 If not set, the current time will be used. !! 107 to somehow debug the behaviour of the kconfig parser/frontends.
>> 108 If not set, the current time will be used.
114 109
115 ``KCONFIG_PROBABILITY`` !! 110 KCONFIG_PROBABILITY
116 This variable can be used to skew the prob !! 111 -------------------
117 be unset or empty, or set to three differe !! 112 This variable can be used to skew the probabilities. This variable can
>> 113 be unset or empty, or set to three different formats:
118 114
119 ======================= ============== 115 ======================= ================== =====================
120 KCONFIG_PROBABILITY y:n split !! 116 KCONFIG_PROBABILITY y:n split y:m:n split
121 ======================= ============== 117 ======================= ================== =====================
122 unset or empty 50 : 50 !! 118 unset or empty 50 : 50 33 : 33 : 34
123 N N : 100-N !! 119 N N : 100-N N/2 : N/2 : 100-N
124 [1] N:M N+M : 100-(N+M 120 [1] N:M N+M : 100-(N+M) N : M : 100-(N+M)
125 [2] N:M:L N : 100-N 121 [2] N:M:L N : 100-N M : L : 100-(M+L)
126 ======================= ============== 122 ======================= ================== =====================
127 123
128 where N, M and L are integers (in base 10) in 124 where N, M and L are integers (in base 10) in the range [0,100], and so
129 that: 125 that:
130 126
131 [1] N+M is in the range [0,100] 127 [1] N+M is in the range [0,100]
132 128
133 [2] M+L is in the range [0,100] 129 [2] M+L is in the range [0,100]
134 130
135 Examples:: 131 Examples::
136 132
137 KCONFIG_PROBABILITY=10 !! 133 KCONFIG_PROBABILITY=10
138 10% of booleans will be set to 'y', 90 !! 134 10% of booleans will be set to 'y', 90% to 'n'
139 5% of tristates will be set to 'y', 5% !! 135 5% of tristates will be set to 'y', 5% to 'm', 90% to 'n'
140 KCONFIG_PROBABILITY=15:25 !! 136 KCONFIG_PROBABILITY=15:25
141 40% of booleans will be set to 'y', 60 !! 137 40% of booleans will be set to 'y', 60% to 'n'
142 15% of tristates will be set to 'y', 2 !! 138 15% of tristates will be set to 'y', 25% to 'm', 60% to 'n'
143 KCONFIG_PROBABILITY=10:15:15 !! 139 KCONFIG_PROBABILITY=10:15:15
144 10% of booleans will be set to 'y', 90 !! 140 10% of booleans will be set to 'y', 90% to 'n'
145 15% of tristates will be set to 'y', 1 !! 141 15% of tristates will be set to 'y', 15% to 'm', 70% to 'n'
146 !! 142
147 Environment variables for ``syncconfig``: !! 143 ----------------------------------------------------------------------
148 !! 144
149 ``KCONFIG_NOSILENTUPDATE`` !! 145 Environment variables for 'syncconfig'
150 If this variable has a non-blank value, it !! 146
151 config updates (requires explicit updates) !! 147 KCONFIG_NOSILENTUPDATE
152 !! 148 ----------------------
153 ``KCONFIG_AUTOCONFIG`` !! 149 If this variable has a non-blank value, it prevents silent kernel
154 This environment variable can be set to sp !! 150 config updates (requires explicit updates).
155 "auto.conf" file. Its default value is "i !! 151
156 !! 152 KCONFIG_AUTOCONFIG
157 ``KCONFIG_AUTOHEADER`` !! 153 ------------------
158 This environment variable can be set to sp !! 154 This environment variable can be set to specify the path & name of the
159 "autoconf.h" (header) file. !! 155 "auto.conf" file. Its default value is "include/config/auto.conf".
160 Its default value is "include/generated/au !! 156
>> 157 KCONFIG_TRISTATE
>> 158 ----------------
>> 159 This environment variable can be set to specify the path & name of the
>> 160 "tristate.conf" file. Its default value is "include/config/tristate.conf".
>> 161
>> 162 KCONFIG_AUTOHEADER
>> 163 ------------------
>> 164 This environment variable can be set to specify the path & name of the
>> 165 "autoconf.h" (header) file.
>> 166 Its default value is "include/generated/autoconf.h".
>> 167
161 168
>> 169 ----------------------------------------------------------------------
162 170
163 menuconfig 171 menuconfig
164 ========== !! 172 ----------
>> 173
>> 174 SEARCHING for CONFIG symbols
165 175
166 Searching in menuconfig: 176 Searching in menuconfig:
167 177
168 The Search function searches for kernel co !! 178 The Search function searches for kernel configuration symbol
169 names, so you have to know something close !! 179 names, so you have to know something close to what you are
170 looking for. !! 180 looking for.
171 181
172 Example:: !! 182 Example::
173 183
174 /hotplug !! 184 /hotplug
175 This lists all config symbols that con !! 185 This lists all config symbols that contain "hotplug",
176 e.g., HOTPLUG_CPU, MEMORY_HOTPLUG. !! 186 e.g., HOTPLUG_CPU, MEMORY_HOTPLUG.
177 187
178 For search help, enter / followed by TAB-T !! 188 For search help, enter / followed by TAB-TAB (to highlight
179 <Help>) and Enter. This will tell you tha !! 189 <Help>) and Enter. This will tell you that you can also use
180 regular expressions (regexes) in the searc !! 190 regular expressions (regexes) in the search string, so if you
181 are not interested in MEMORY_HOTPLUG, you !! 191 are not interested in MEMORY_HOTPLUG, you could try::
182 192
183 /^hotplug !! 193 /^hotplug
184 194
185 When searching, symbols are sorted thus: !! 195 When searching, symbols are sorted thus:
186 196
187 - first, exact matches, sorted alphabetica !! 197 - first, exact matches, sorted alphabetically (an exact match
188 is when the search matches the complete !! 198 is when the search matches the complete symbol name);
189 - then, other matches, sorted alphabetical !! 199 - then, other matches, sorted alphabetically.
190 200
191 For example, ^ATH.K matches: !! 201 For example: ^ATH.K matches:
192 202
193 ATH5K ATH9K ATH5K_AHB ATH5K_DEBUG [... !! 203 ATH5K ATH9K ATH5K_AHB ATH5K_DEBUG [...] ATH6KL ATH6KL_DEBUG
194 [...] ATH9K_AHB ATH9K_BTCOEX_SUPPORT A !! 204 [...] ATH9K_AHB ATH9K_BTCOEX_SUPPORT ATH9K_COMMON [...]
195 205
196 of which only ATH5K and ATH9K match exactl !! 206 of which only ATH5K and ATH9K match exactly and so are sorted
197 first (and in alphabetical order), then co !! 207 first (and in alphabetical order), then come all other symbols,
198 sorted in alphabetical order. !! 208 sorted in alphabetical order.
199 209
200 In this menu, pressing the key in the (#) !! 210 ----------------------------------------------------------------------
201 directly to that location. You will be ret <<
202 search results after exiting this new menu <<
203 211
204 User interface options for 'menuconfig': !! 212 User interface options for 'menuconfig'
205 213
206 ``MENUCONFIG_COLOR`` !! 214 MENUCONFIG_COLOR
207 It is possible to select different color t !! 215 ----------------
208 MENUCONFIG_COLOR. To select a theme use:: !! 216 It is possible to select different color themes using the variable
>> 217 MENUCONFIG_COLOR. To select a theme use::
209 218
210 make MENUCONFIG_COLOR=<theme> menuconf !! 219 make MENUCONFIG_COLOR=<theme> menuconfig
211 220
212 Available themes are:: !! 221 Available themes are::
213 222
214 - mono => selects colors suitable !! 223 - mono => selects colors suitable for monochrome displays
215 - blackbg => selects a color scheme w !! 224 - blackbg => selects a color scheme with black background
216 - classic => theme with blue backgrou !! 225 - classic => theme with blue background. The classic look
217 - bluetitle => a LCD friendly version o !! 226 - bluetitle => a LCD friendly version of classic. (default)
218 227
219 ``MENUCONFIG_MODE`` !! 228 MENUCONFIG_MODE
220 This mode shows all sub-menus in one large !! 229 ---------------
>> 230 This mode shows all sub-menus in one large tree.
221 231
222 Example:: !! 232 Example::
223 233
224 make MENUCONFIG_MODE=single_menu menuc !! 234 make MENUCONFIG_MODE=single_menu menuconfig
225 235
>> 236 ----------------------------------------------------------------------
226 237
227 nconfig 238 nconfig
228 ======= !! 239 -------
229 240
230 nconfig is an alternate text-based configurato 241 nconfig is an alternate text-based configurator. It lists function
231 keys across the bottom of the terminal (window 242 keys across the bottom of the terminal (window) that execute commands.
232 You can also just use the corresponding numeri 243 You can also just use the corresponding numeric key to execute the
233 commands unless you are in a data entry window 244 commands unless you are in a data entry window. E.g., instead of F6
234 for Save, you can just press 6. 245 for Save, you can just press 6.
235 246
236 Use F1 for Global help or F3 for the Short hel 247 Use F1 for Global help or F3 for the Short help menu.
237 248
238 Searching in nconfig: 249 Searching in nconfig:
239 250
240 You can search either in the menu entry "p !! 251 You can search either in the menu entry "prompt" strings
241 or in the configuration symbols. !! 252 or in the configuration symbols.
242 <<
243 Use / to begin a search through the menu e <<
244 not support regular expressions. Use <Dow <<
245 Next hit and Previous hit, respectively. <<
246 terminate the search mode. <<
247 253
248 F8 (SymSearch) searches the configuration !! 254 Use / to begin a search through the menu entries. This does
249 given string or regular expression (regex) !! 255 not support regular expressions. Use <Down> or <Up> for
>> 256 Next hit and Previous hit, respectively. Use <Esc> to
>> 257 terminate the search mode.
250 258
251 In the SymSearch, pressing the key in the !! 259 F8 (SymSearch) searches the configuration symbols for the
252 jump directly to that location. You will b !! 260 given string or regular expression (regex).
253 current search results after exiting this <<
254 261
255 Environment variables: !! 262 NCONFIG_MODE
>> 263 ------------
>> 264 This mode shows all sub-menus in one large tree.
256 265
257 ``NCONFIG_MODE`` !! 266 Example::
258 This mode shows all sub-menus in one large <<
259 267
260 Example:: !! 268 make NCONFIG_MODE=single_menu nconfig
261 <<
262 make NCONFIG_MODE=single_menu nconfig <<
263 269
>> 270 ----------------------------------------------------------------------
264 271
265 xconfig 272 xconfig
266 ======= !! 273 -------
267 274
268 Searching in xconfig: 275 Searching in xconfig:
269 276
270 The Search function searches for kernel co !! 277 The Search function searches for kernel configuration symbol
271 names, so you have to know something close !! 278 names, so you have to know something close to what you are
272 looking for. !! 279 looking for.
>> 280
>> 281 Example::
273 282
274 Example:: !! 283 Ctrl-F hotplug
275 284
276 Ctrl-F hotplug !! 285 or::
277 286
278 or:: !! 287 Menu: File, Search, hotplug
279 288
280 Menu: File, Search, hotplug !! 289 lists all config symbol entries that contain "hotplug" in
>> 290 the symbol name. In this Search dialog, you may change the
>> 291 config setting for any of the entries that are not grayed out.
>> 292 You can also enter a different search string without having
>> 293 to return to the main menu.
281 294
282 lists all config symbol entries that conta <<
283 the symbol name. In this Search dialog, y <<
284 config setting for any of the entries that <<
285 You can also enter a different search stri <<
286 to return to the main menu. <<
287 295
>> 296 ----------------------------------------------------------------------
288 297
289 gconfig 298 gconfig
290 ======= !! 299 -------
291 300
292 Searching in gconfig: 301 Searching in gconfig:
293 302
294 There is no search command in gconfig. Ho !! 303 There is no search command in gconfig. However, gconfig does
295 have several different viewing choices, mo !! 304 have several different viewing choices, modes, and options.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.