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