diff options
| author | Roland Eggner <edvx1@systemanalysen.net> | 2013-02-01 13:27:04 -0500 |
|---|---|---|
| committer | Yann E. MORIN <yann.morin.1998@free.fr> | 2013-02-08 19:42:35 -0500 |
| commit | 0b61650044e9044d3843047fe015fc0ea7943430 (patch) | |
| tree | 92f57772bdf89993b70ed666f06b18593cce8896 /scripts/kconfig | |
| parent | aed9934bf182c049d966bd106ad7e2b43c46c718 (diff) | |
kconfig: nconf: rewrite help texts
>From: Roland Eggner <edvx1@systemanalysen.net>
Rewrite all help texts. During several years lazy (incomplete) updates have
left behind a rather thick layer of dust. Intentions:
(1) Global help called by <F1> should document all _currently_ implemented
keybindings.
(2) Different help texts called by <F3> resp. <F8><F1> should be consistent
with (1) and with implementation:
• on plain menu entry
• in radiolist window
• in input windows for text, decimal or hexadecimal values
• in filename selection windows <F6> <F7>
• SymSearch specific help called by <F8> followed by <F1>
(3) More reasonable window titles:
Rename window title s/README/Global help/
Rename variable s/nconf_readme/nconf_global_help/
Rename window title s/Instructions/Short help/
(4) Consider which hints are most useful for first-time-users.
Signed-off-by: Roland Eggner <edvx1@systemanalysen.net>
Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
[yann.morin.1998@free.fr: a few additional fixes]
Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Diffstat (limited to 'scripts/kconfig')
| -rw-r--r-- | scripts/kconfig/nconf.c | 320 |
1 files changed, 156 insertions, 164 deletions
diff --git a/scripts/kconfig/nconf.c b/scripts/kconfig/nconf.c index ce93e879a29c..65c672cce823 100644 --- a/scripts/kconfig/nconf.c +++ b/scripts/kconfig/nconf.c | |||
| @@ -13,210 +13,202 @@ | |||
| 13 | #include "nconf.h" | 13 | #include "nconf.h" |
| 14 | #include <ctype.h> | 14 | #include <ctype.h> |
| 15 | 15 | ||
| 16 | static const char nconf_readme[] = N_( | 16 | static const char nconf_global_help[] = N_( |
| 17 | "Overview\n" | 17 | "Help windows\n" |
| 18 | "--------\n" | 18 | "------------\n" |
| 19 | "This interface let you select features and parameters for the build.\n" | 19 | "o Global help: Unless in a data entry window, pressing <F1> will give \n" |
| 20 | "Features can either be built-in, modularized, or ignored. Parameters\n" | 20 | " you the global help window, which you are just reading.\n" |
| 21 | "must be entered in as decimal or hexadecimal numbers or text.\n" | ||
| 22 | "\n" | 21 | "\n" |
| 23 | "Menu items beginning with following braces represent features that\n" | 22 | "o A short version of the global help is available by pressing <F3>.\n" |
| 24 | " [ ] can be built in or removed\n" | ||
| 25 | " < > can be built in, modularized or removed\n" | ||
| 26 | " { } can be built in or modularized (selected by other feature)\n" | ||
| 27 | " - - are selected by other feature,\n" | ||
| 28 | " XXX cannot be selected. Use Symbol Info to find out why,\n" | ||
| 29 | "while *, M or whitespace inside braces means to build in, build as\n" | ||
| 30 | "a module or to exclude the feature respectively.\n" | ||
| 31 | "\n" | 23 | "\n" |
| 32 | "To change any of these features, highlight it with the cursor\n" | 24 | "o Local help: To get help related to the current menu entry, use any\n" |
| 33 | "keys and press <Y> to build it in, <M> to make it a module or\n" | 25 | " of <?> <h>, or if in a data entry window then press <F1>.\n" |
| 34 | "<N> to removed it. You may also press the <Space Bar> to cycle\n" | ||
| 35 | "through the available options (ie. Y->N->M->Y).\n" | ||
| 36 | "\n" | 26 | "\n" |
| 37 | "Some additional keyboard hints:\n" | ||
| 38 | "\n" | 27 | "\n" |
| 39 | "Menus\n" | 28 | "Menu entries\n" |
| 40 | "----------\n" | 29 | "------------\n" |
| 41 | "o Use the Up/Down arrow keys (cursor keys) to highlight the item\n" | 30 | "This interface lets you select features and parameters for the kernel\n" |
| 42 | " you wish to change use <Enter> or <Space>. Goto submenu by \n" | 31 | "build. Kernel features can either be built-in, modularized, or removed.\n" |
| 43 | " pressing <Enter> of <right-arrow>. Use <Esc> or <left-arrow> to go back.\n" | 32 | "Parameters must be entered as text or decimal or hexadecimal numbers.\n" |
| 44 | " Submenus are designated by \"--->\".\n" | ||
| 45 | "\n" | ||
| 46 | " Searching: pressing '/' triggers interactive search mode.\n" | ||
| 47 | " nconfig performs a case insensitive search for the string\n" | ||
| 48 | " in the menu prompts (no regex support).\n" | ||
| 49 | " Pressing the up/down keys highlights the previous/next\n" | ||
| 50 | " matching item. Backspace removes one character from the\n" | ||
| 51 | " match string. Pressing either '/' again or ESC exits\n" | ||
| 52 | " search mode. All other keys behave normally.\n" | ||
| 53 | "\n" | 33 | "\n" |
| 54 | " You may also use the <PAGE UP> and <PAGE DOWN> keys to scroll\n" | 34 | "Menu entries beginning with following braces represent features that\n" |
| 55 | " unseen options into view.\n" | 35 | " [ ] can be built in or removed\n" |
| 36 | " < > can be built in, modularized or removed\n" | ||
| 37 | " { } can be built in or modularized, are selected by another feature\n" | ||
| 38 | " - - are selected by another feature\n" | ||
| 39 | " XXX cannot be selected. Symbol Info <F2> tells you why.\n" | ||
| 40 | "*, M or whitespace inside braces means to build in, build as a module\n" | ||
| 41 | "or to exclude the feature respectively.\n" | ||
| 56 | "\n" | 42 | "\n" |
| 57 | "o To exit a menu use the just press <ESC> <F5> <F8> or <left-arrow>.\n" | 43 | "To change any of these features, highlight it with the movement keys\n" |
| 44 | "listed below and press <y> to build it in, <m> to make it a module or\n" | ||
| 45 | "<n> to remove it. You may press the <Space> key to cycle through the\n" | ||
| 46 | "available options.\n" | ||
| 58 | "\n" | 47 | "\n" |
| 59 | "o To get help with an item, press <F1>\n" | 48 | "A trailing \"--->\" designates a submenu.\n" |
| 60 | " Shortcut: Press <h> or <?>.\n" | ||
| 61 | "\n" | 49 | "\n" |
| 62 | "\n" | 50 | "\n" |
| 63 | "Radiolists (Choice lists)\n" | 51 | "Menu navigation keys\n" |
| 64 | "-----------\n" | 52 | "----------------------------------------------------------------------\n" |
| 65 | "o Use the cursor keys to select the option you wish to set and press\n" | 53 | "Linewise up <Up>\n" |
| 66 | " <S> or the <SPACE BAR>.\n" | 54 | "Linewise down <Down>\n" |
| 55 | "Pagewise up <Page Up>\n" | ||
| 56 | "Pagewise down <Page Down>\n" | ||
| 57 | "First entry <Home>\n" | ||
| 58 | "Last entry <End>\n" | ||
| 59 | "Enter a submenu <Right> <Enter>\n" | ||
| 60 | "Go back to parent menu <Left> <Esc> <F5>\n" | ||
| 61 | "Close a help window <Enter> <Esc> <F5>\n" | ||
| 62 | "Close entry window, apply <Enter>\n" | ||
| 63 | "Close entry window, forget <Esc> <F5>\n" | ||
| 64 | "Start incremental, case-insensitive search for STRING in menu entries,\n" | ||
| 65 | " no regex support, STRING is displayed in upper left corner\n" | ||
| 66 | " </>STRING\n" | ||
| 67 | " Remove last character <Backspace>\n" | ||
| 68 | " Jump to next hit <Down>\n" | ||
| 69 | " Jump to previous hit <Up>\n" | ||
| 70 | "Exit menu search mode </> <Esc>\n" | ||
| 71 | "Search for configuration variables with or without leading CONFIG_\n" | ||
| 72 | " <F8>RegExpr<Enter>\n" | ||
| 73 | "Verbose search help <F8><F1>\n" | ||
| 74 | "----------------------------------------------------------------------\n" | ||
| 67 | "\n" | 75 | "\n" |
| 68 | " Shortcut: Press the first letter of the option you wish to set then\n" | 76 | "Unless in a data entry window, key <1> may be used instead of <F1>,\n" |
| 69 | " press <S> or <SPACE BAR>.\n" | 77 | "<2> instead of <F2>, etc.\n" |
| 70 | "\n" | 78 | "\n" |
| 71 | "o To see available help for the item, press <F1>\n" | ||
| 72 | " Shortcut: Press <H> or <?>.\n" | ||
| 73 | "\n" | 79 | "\n" |
| 80 | "Radiolist (Choice list)\n" | ||
| 81 | "-----------------------\n" | ||
| 82 | "Use the movement keys listed above to select the option you wish to set\n" | ||
| 83 | "and press <Space>.\n" | ||
| 74 | "\n" | 84 | "\n" |
| 75 | "Data Entry\n" | ||
| 76 | "-----------\n" | ||
| 77 | "o Enter the requested information and press <ENTER>\n" | ||
| 78 | " If you are entering hexadecimal values, it is not necessary to\n" | ||
| 79 | " add the '0x' prefix to the entry.\n" | ||
| 80 | "\n" | 85 | "\n" |
| 81 | "o For help, press <F1>.\n" | 86 | "Data entry\n" |
| 87 | "----------\n" | ||
| 88 | "Enter the requested information and press <Enter>. Hexadecimal values\n" | ||
| 89 | "may be entered without the \"0x\" prefix.\n" | ||
| 82 | "\n" | 90 | "\n" |
| 83 | "\n" | 91 | "\n" |
| 84 | "Text Box (Help Window)\n" | 92 | "Text Box (Help Window)\n" |
| 85 | "--------\n" | 93 | "----------------------\n" |
| 86 | "o Use the cursor keys to scroll up/down/left/right. The VI editor\n" | 94 | "Use movement keys as listed in table above.\n" |
| 87 | " keys h,j,k,l function here as do <u>, <d> and <SPACE BAR> for\n" | ||
| 88 | " those who are familiar with less and lynx.\n" | ||
| 89 | "\n" | 95 | "\n" |
| 90 | "o Press <Enter>, <F1>, <F5>, <F9>, <q> or <Esc> to exit.\n" | 96 | "Press any of <Enter> <Esc> <q> <F5> <F9> to exit.\n" |
| 91 | "\n" | 97 | "\n" |
| 92 | "\n" | 98 | "\n" |
| 93 | "Alternate Configuration Files\n" | 99 | "Alternate configuration files\n" |
| 94 | "-----------------------------\n" | 100 | "-----------------------------\n" |
| 95 | "nconfig supports the use of alternate configuration files for\n" | 101 | "nconfig supports switching between different configurations.\n" |
| 96 | "those who, for various reasons, find it necessary to switch\n" | 102 | "Press <F6> to save your current configuration. Press <F7> and enter\n" |
| 97 | "between different configurations.\n" | 103 | "a file name to load a previously saved configuration.\n" |
| 98 | "\n" | 104 | "\n" |
| 99 | "At the end of the main menu you will find two options. One is\n" | ||
| 100 | "for saving the current configuration to a file of your choosing.\n" | ||
| 101 | "The other option is for loading a previously saved alternate\n" | ||
| 102 | "configuration.\n" | ||
| 103 | "\n" | 105 | "\n" |
| 104 | "Even if you don't use alternate configuration files, but you\n" | 106 | "Terminal configuration\n" |
| 105 | "find during a nconfig session that you have completely messed\n" | 107 | "----------------------\n" |
| 106 | "up your settings, you may use the \"Load Alternate...\" option to\n" | 108 | "If you use nconfig in a xterm window, make sure your TERM environment\n" |
| 107 | "restore your previously saved settings from \".config\" without\n" | 109 | "variable specifies a terminal configuration which supports at least\n" |
| 108 | "restarting nconfig.\n" | ||