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