Documentation/kbuild/kconfig.rst

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