Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

kconfig: update user kconfig tools doc.

Update Documentation/kbuild/kconfig.txt, which mostly contains
user help for using the kernel config tools.

- Add mention of 'nconfig' embedded help text.
- Make the section on new config symbols readable.
- Correct how to find menuconfig search help.
- Add section on 'nconfig' usage.
- Mention that gconfig has multiple viewing modes/options.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>

authored by

Randy Dunlap and committed by
Masahiro Yamada
452d4c86 3f9cdee5

+43 -8
+43 -8
Documentation/kbuild/kconfig.txt
··· 2 2 3 3 Use "make help" to list all of the possible configuration targets. 4 4 5 - The xconfig ('qconf') and menuconfig ('mconf') programs also 6 - have embedded help text. Be sure to check it for navigation, 7 - search, and other general help text. 5 + The xconfig ('qconf'), menuconfig ('mconf'), and nconfig ('nconf') 6 + programs also have embedded help text. Be sure to check that for 7 + navigation, search, and other general help text. 8 8 9 9 ====================================================================== 10 10 General ··· 17 17 for you, so you may find that you need to see what NEW kernel 18 18 symbols have been introduced. 19 19 20 - To see a list of new config symbols when using "make oldconfig", use 20 + To see a list of new config symbols, use 21 21 22 22 cp user/some/old.config .config 23 23 make listnewconfig 24 24 25 25 and the config program will list any new symbols, one per line. 26 26 27 + Alternatively, you can use the brute force method: 28 + 29 + make oldconfig 27 30 scripts/diffconfig .config.old .config | less 28 31 29 32 ______________________________________________________________________ ··· 163 160 This lists all config symbols that contain "hotplug", 164 161 e.g., HOTPLUG_CPU, MEMORY_HOTPLUG. 165 162 166 - For search help, enter / followed TAB-TAB-TAB (to highlight 163 + For search help, enter / followed by TAB-TAB (to highlight 167 164 <Help>) and Enter. This will tell you that you can also use 168 165 regular expressions (regexes) in the search string, so if you 169 166 are not interested in MEMORY_HOTPLUG, you could try ··· 206 203 207 204 208 205 ====================================================================== 206 + nconfig 207 + -------------------------------------------------- 208 + 209 + nconfig is an alternate text-based configurator. It lists function 210 + keys across the bottom of the terminal (window) that execute commands. 211 + You can also just use the corresponding numeric key to execute the 212 + commands unless you are in a data entry window. E.g., instead of F6 213 + for Save, you can just press 6. 214 + 215 + Use F1 for Global help or F3 for the Short help menu. 216 + 217 + Searching in nconfig: 218 + 219 + You can search either in the menu entry "prompt" strings 220 + or in the configuration symbols. 221 + 222 + Use / to begin a search through the menu entries. This does 223 + not support regular expressions. Use <Down> or <Up> for 224 + Next hit and Previous hit, respectively. Use <Esc> to 225 + terminate the search mode. 226 + 227 + F8 (SymSearch) searches the configuration symbols for the 228 + given string or regular expression (regex). 229 + 230 + NCONFIG_MODE 231 + -------------------------------------------------- 232 + This mode shows all sub-menus in one large tree. 233 + 234 + Example: 235 + make NCONFIG_MODE=single_menu nconfig 236 + 237 + 238 + ====================================================================== 209 239 xconfig 210 240 -------------------------------------------------- 211 241 ··· 266 230 267 231 Searching in gconfig: 268 232 269 - None (gconfig isn't maintained as well as xconfig or menuconfig); 270 - however, gconfig does have a few more viewing choices than 271 - xconfig does. 233 + There is no search command in gconfig. However, gconfig does 234 + have several different viewing choices, modes, and options. 272 235 273 236 ###