Re: [PATCH resend v3 1/3] kconfig: nconf: rewrite help texts
On 2013-02-09 Saturday at 12:23 +0100 Yann E. MORIN wrote: > Rolland, All, > > On Saturday 09 February 2013 Roland Eggner wrote: > > On 2013-02-09 Saturday at 01:30 +0100 Yann E. MORIN wrote: > [--SNIP--] > > > > +"Text Box (Help Window)\n" > > > > +"--\n" > > > > +"Use movement keys as > > > > listed in\n" > > > > +"table above.\n" > > > > > > ... keys [elided] as listed ... > > > > Ok, because you are dropping patch 3/3. > > If that was related to patch 3/3, that should have been in that patch, > not this one. My “Ok, because …” referred to your “keys [elided] as listed …” in that particular hunk, whereas my “You performed a nice polish …” several hunks later referred to the whole patch. Just to avoid misunderstanding. > > [--SNIP--] > > > Any reason for the re-indent with one more space? > > > > Intention is optimization for fast reading, as usual in professional text > > processing: seperate words by single space; separate sentences, > > half-sentences > > and listing symbols by two spaces. > > OK, I kept it. Thank you. -- Regards Roland Eggner pgpFm1MoAh3Zj.pgp Description: PGP signature
Re: [PATCH resend v3 1/3] kconfig: nconf: rewrite help texts
Rolland, All, On Saturday 09 February 2013 Roland Eggner wrote: > On 2013-02-09 Saturday at 01:30 +0100 Yann E. MORIN wrote: [--SNIP--] > > > +"Text Box (Help Window)\n" > > > +"--\n" > > > +"Use movement keys as > > > listed in\n" > > > +"table above.\n" > > > > ... keys [elided] as listed ... > > Ok, because you are dropping patch 3/3. If that was related to patch 3/3, that should have been in that patch, not this one. [--SNIP--] > > Any reason for the re-indent with one more space? > > Intention is optimization for fast reading, as usual in professional text > processing: seperate words by single space; separate sentences, > half-sentences > and listing symbols by two spaces. OK, I kept it. Regards, Yann E. MORIN. -- .-..--.. | Yann E. MORIN | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: | | +33 662 376 056 | Software Designer | \ / CAMPAIGN | ___ | | +33 223 225 172 `.---: X AGAINST | \e/ There is no | | http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL| v conspiracy. | '--^---^--^' -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
Re: [PATCH resend v3 1/3] kconfig: nconf: rewrite help texts
Rolland, All, On Saturday 09 February 2013 Roland Eggner wrote: On 2013-02-09 Saturday at 01:30 +0100 Yann E. MORIN wrote: [--SNIP--] +Text Box (Help Window)\n +--\n +Use movement keys Down Up PageDown PageUp End Home as listed in\n +table above.\n ... keys [elided] as listed ... Ok, because you are dropping patch 3/3. If that was related to patch 3/3, that should have been in that patch, not this one. [--SNIP--] Any reason for the re-indent with one more space? Intention is optimization for fast reading, as usual in professional text processing: seperate words by single space; separate sentences, half-sentences and listing symbols by two spaces. OK, I kept it. Regards, Yann E. MORIN. -- .-..--.. | Yann E. MORIN | Real-Time Embedded | /\ ASCII RIBBON | Erics' conspiracy: | | +33 662 376 056 | Software Designer | \ / CAMPAIGN | ___ | | +33 223 225 172 `.---: X AGAINST | \e/ There is no | | http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL| v conspiracy. | '--^---^--^' -- To unsubscribe from this list: send the line unsubscribe linux-kernel in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
Re: [PATCH resend v3 1/3] kconfig: nconf: rewrite help texts
On 2013-02-09 Saturday at 12:23 +0100 Yann E. MORIN wrote: Rolland, All, On Saturday 09 February 2013 Roland Eggner wrote: On 2013-02-09 Saturday at 01:30 +0100 Yann E. MORIN wrote: [--SNIP--] +Text Box (Help Window)\n +--\n +Use movement keys Down Up PageDown PageUp End Home as listed in\n +table above.\n ... keys [elided] as listed ... Ok, because you are dropping patch 3/3. If that was related to patch 3/3, that should have been in that patch, not this one. My “Ok, because …” referred to your “keys [elided] as listed …” in that particular hunk, whereas my “You performed a nice polish …” several hunks later referred to the whole patch. Just to avoid misunderstanding. [--SNIP--] Any reason for the re-indent with one more space? Intention is optimization for fast reading, as usual in professional text processing: seperate words by single space; separate sentences, half-sentences and listing symbols by two spaces. OK, I kept it. Thank you. -- Regards Roland Eggner pgpFm1MoAh3Zj.pgp Description: PGP signature
Re: [PATCH resend v3 1/3] kconfig: nconf: rewrite help texts
On 2013-02-09 Saturday at 01:30 +0100 Yann E. MORIN wrote: > Roland, All, > > I've taken that in my branch now. > I will push later with a few fixes (see below). > > On Friday 01 February 2013 Roland Eggner wrote: > [--SNIP--] > > diff --git a/scripts/kconfig/nconf.c b/scripts/kconfig/nconf.c > > --- a/scripts/kconfig/nconf.c > > +++ b/scripts/kconfig/nconf.c > [--SNIP--] > > +"o Global help: Unless in a data entry window, key will give you\n" > > ... pressing ... > > > +"o A short version of the global help is available by key .\n" > > ... by pressing > > > +"o Local help: To get help related to the current menu entry, use any\n" > > +" of keys, or if in a data entry window then use key.\n" > > s/ keys//; s/use key/press /; > > > +" to remove it. You may press the key to cycle through the\n" > > ... press to cycle ... > > > +"Unless in a data entry window, key <1> may be used instead of ,\n" > > s/key //; > > > +"Enter the requested information and press . Hexadecimal values\n" > > +"may be entered without \"0x\" prefix.\n" > > ... without the \"0x\" prefix ... > > > +"Text Box (Help Window)\n" > > +"--\n" > > +"Use movement keys as listed > > in\n" > > +"table above.\n" > > ... keys [elided] as listed ... Ok, because you are dropping patch 3/3. > > +"Alternate configuration files\n" > > +"-\n" > > +"nconfig supports switching between different configurations.\n" > > +"Use to save your current configuration. Use and enter a\n" > > Press ... > Press ... > > > menu_no_f_instructions[] = N_( > [--SNIP--] > > +"Legend: [*] built-in [ ] excluded module < > module capable.\n" > > +"Submenus are designated by a trailing \"--->\".\n" > > +"\n" > > +"Use the following keys to navigate the menus:\n" > > +"Move up or down by any of keys.\n" > > ... with or . > > > +"To enter a submenu use any of keys.\n" > > +"To go back to the parent menu use any of keys.\n" > > Enter a submenu with or . > Exit a submenu to its parent menu with or . > > > +"Pressing includes, excludes, modularizes features.\n" > > +"Pressing cycles through the available options.\n" > > +"To search for menu entries use key .\n" > > ... press . > > > +" always leaves the current window.\n" > > +"\n" > > +"You do not have function keys support.\n" > > +"Use key <1> instead of , <2> instead of , etc.\n" > > +"For verbose global help use key <1>.\n" > > ... press <1>. > > > +"For help related to the current menu entry use any of keys.\n"), > > ... press or . > > And so on in the following... You performed a nice “polish“ … thank you! > … … > > @@ -229,26 +222,26 @@ search_help[] = N_( > > "Selects: LIBCRC32\n" > > "Selected by: BAR\n" > > "-\n" > > -"o The line 'Prompt:' shows the text used in the menu structure for\n" > > -" this symbol\n" > > -"o The 'Defined at' line tell at what file / line number the symbol\n" > > -" is defined\n" > > -"o The 'Depends on:' line tell what symbols needs to be defined for\n" > > -" this symbol to be visible in the menu (selectable)\n" > > -"o The 'Location:' lines tell where in the menu structure this symbol\n" > > -" is located\n" > > -"A location followed by a [ = y] indicate that this is a selectable\n" > > -"menu item - and current value is displayed inside brackets.\n" > > -"o The 'Selects:' line tell what symbol will be automatically\n" > > -" selected if this symbol is selected (y or m)\n" > > -"o The 'Selected by' line tell what symbol has selected this symbol\n" > > +"o The line 'Prompt:' shows the menu text displayed for this symbol in\n" > > ... shows the [elided] text ... > > Any reason for the re-indent with one more space? Intention is optimization for fast reading, as usual in professional text processing: seperate words by single space; separate sentences, half-sentences and listing symbols by two spaces. > > +" the menu hierarchy.\n" > > +"o The 'Defined at' line tells at what file / line number the symbol is\n" > > ... file & line ... > > > +"o The 'Depends on:' line tells, what symbols need to be defined for\n" > > ... line lists symbols that need ... > > I will push soon to my branch. Thank you! -- Regards Roland Eggner pgpAS4zLdbqKk.pgp Description: PGP signature
Re: [PATCH resend v3 1/3] kconfig: nconf: rewrite help texts
Roland, All, I've taken that in my branch now. I will push later with a few fixes (see below). On Friday 01 February 2013 Roland Eggner wrote: [--SNIP--] > diff --git a/scripts/kconfig/nconf.c b/scripts/kconfig/nconf.c > --- a/scripts/kconfig/nconf.c > +++ b/scripts/kconfig/nconf.c [--SNIP--] > +"o Global help: Unless in a data entry window, key will give you\n" ... pressing ... > +"o A short version of the global help is available by key .\n" ... by pressing > +"o Local help: To get help related to the current menu entry, use any\n" > +" of keys, or if in a data entry window then use key.\n" s/ keys//; s/use key/press /; > +" to remove it. You may press the key to cycle through the\n" ... press to cycle ... > +"Unless in a data entry window, key <1> may be used instead of ,\n" s/key //; > +"Enter the requested information and press . Hexadecimal values\n" > +"may be entered without \"0x\" prefix.\n" ... without the \"0x\" prefix ... > +"Text Box (Help Window)\n" > +"--\n" > +"Use movement keys as listed > in\n" > +"table above.\n" ... keys [elided] as listed ... > +"Alternate configuration files\n" > +"-\n" > +"nconfig supports switching between different configurations.\n" > +"Use to save your current configuration. Use and enter a\n" Press ... Press ... > menu_no_f_instructions[] = N_( [--SNIP--] > +"Legend: [*] built-in [ ] excluded module < > module capable.\n" > +"Submenus are designated by a trailing \"--->\".\n" > +"\n" > +"Use the following keys to navigate the menus:\n" > +"Move up or down by any of keys.\n" ... with or . > +"To enter a submenu use any of keys.\n" > +"To go back to the parent menu use any of keys.\n" Enter a submenu with or . Exit a submenu to its parent menu with or . > +"Pressing includes, excludes, modularizes features.\n" > +"Pressing cycles through the available options.\n" > +"To search for menu entries use key .\n" ... press . > +" always leaves the current window.\n" > +"\n" > +"You do not have function keys support.\n" > +"Use key <1> instead of , <2> instead of , etc.\n" > +"For verbose global help use key <1>.\n" ... press <1>. > +"For help related to the current menu entry use any of keys.\n"), ... press or . And so on in the following... > setmod_text[] = N_( > -"This feature depends on another which\n" > -"has been configured as a module.\n" > -"As a result, this feature will be built as a module."), > +"This feature depends on another feature which has been configured as a\n" > +"module. As a result, the current feature will be built as a module too."), > load_config_text[] = N_( > "Enter the name of the configuration file you wish to load.\n" > -"Accept the name shown to restore the configuration you\n" > -"last retrieved. Leave blank to abort."), > +"Accept the name shown to restore the configuration you retrieved\n" > +"last. Leave empty to abort."), "the configuration you last retrieved" is prefectly correct English (at least UK english ;-) ), and the meaning is (very) slightly different. In this case, I think it's more sensible to keep the original wording. But English is not my primary language, so feel free to correct me... > load_config_help[] = N_( > -"\n" > "For various reasons, one may wish to keep several different\n" > "configurations available on a single machine.\n" > "\n" > "If you have saved a previous configuration in a file other than the\n" > -"default one, entering its name here will allow you to modify that\n" > -"configuration.\n" > +"default one, entering its name here will allow you to load and modify\n" > +"that configuration.\n" > "\n" > -"If you are uncertain, then you have probably never used alternate\n" > -"configuration files. You should therefor leave this blank to abort.\n"), > +"Leave empty to abort.\n"), > save_config_text[] = N_( > "Enter a filename to which this configuration should be saved\n" > -"as an alternate. Leave blank to abort."), > +"as an alternate. Leave empty to abort."), > save_config_help[] = N_( > -"\n" > -"For various reasons, one may wish to keep different configurations\n" > -"available on a single machine.\n" > +"For various reasons, one may wish to keep several different\n" > +"configurations available on a single machine.\n" > "\n" > "Entering a file name here will allow you to later retrieve, modify\n" > "and use the current configuration as an alternate to whatever\n" > "configuration options you have selected at that time.\n" > "\n" > -"If you are uncertain what all this means then you should probably\n" > -"leave this blank.\n"), > +"Leave empty to abort.\n"), > search_help[] = N_( > -"\n" > -"Search for symbols and display their relations. Regular expressions\n" > -"are allowed.\n" > -"Example: search for \"^FOO\"\n" > +"Search for symbols (configuration variable names CONFIG_*) and display\n" > +"their relations. Regular expressions are
Re: [PATCH resend v3 1/3] kconfig: nconf: rewrite help texts
Roland, All, I've taken that in my branch now. I will push later with a few fixes (see below). On Friday 01 February 2013 Roland Eggner wrote: [--SNIP--] diff --git a/scripts/kconfig/nconf.c b/scripts/kconfig/nconf.c --- a/scripts/kconfig/nconf.c +++ b/scripts/kconfig/nconf.c [--SNIP--] +o Global help: Unless in a data entry window, key F1 will give you\n ... pressing F1 ... +o A short version of the global help is available by key F3.\n ... by pressing F3 +o Local help: To get help related to the current menu entry, use any\n + of ? h keys, or if in a data entry window then use F1 key.\n s/ keys//; s/use F1 key/press F1/; +n to remove it. You may press the Space key to cycle through the\n ... press Space to cycle ... +Unless in a data entry window, key 1 may be used instead of F1,\n s/key //; +Enter the requested information and press Enter. Hexadecimal values\n +may be entered without \0x\ prefix.\n ... without the \0x\ prefix ... +Text Box (Help Window)\n +--\n +Use movement keys Down Up PageDown PageUp End Home as listed in\n +table above.\n ... keys [elided] as listed ... +Alternate configuration files\n +-\n +nconfig supports switching between different configurations.\n +Use F6 to save your current configuration. Use F7 and enter a\n Press F6 ... Press F7 ... menu_no_f_instructions[] = N_( [--SNIP--] +Legend: [*] built-in [ ] excluded M modulemodule capable.\n +Submenus are designated by a trailing \---\.\n +\n +Use the following keys to navigate the menus:\n +Move up or down by any of Up Down keys.\n ... with Up or Down. +To enter a submenu use any of Enter Right keys.\n +To go back to the parent menu use any of Esc Left keys.\n Enter a submenu with Enter or Right. Exit a submenu to its parent menu with Esc or Left. +Pressing y includes, n excludes, m modularizes features.\n +Pressing Space cycles through the available options.\n +To search for menu entries use key /.\n ... press /. +Esc always leaves the current window.\n +\n +You do not have function keys support.\n +Use key 1 instead of F1, 2 instead of F2, etc.\n +For verbose global help use key 1.\n ... press 1. +For help related to the current menu entry use any of ? h keys.\n), ... press ? or h. And so on in the following... setmod_text[] = N_( -This feature depends on another which\n -has been configured as a module.\n -As a result, this feature will be built as a module.), +This feature depends on another feature which has been configured as a\n +module. As a result, the current feature will be built as a module too.), load_config_text[] = N_( Enter the name of the configuration file you wish to load.\n -Accept the name shown to restore the configuration you\n -last retrieved. Leave blank to abort.), +Accept the name shown to restore the configuration you retrieved\n +last. Leave empty to abort.), the configuration you last retrieved is prefectly correct English (at least UK english ;-) ), and the meaning is (very) slightly different. In this case, I think it's more sensible to keep the original wording. But English is not my primary language, so feel free to correct me... load_config_help[] = N_( -\n For various reasons, one may wish to keep several different\n configurations available on a single machine.\n \n If you have saved a previous configuration in a file other than the\n -default one, entering its name here will allow you to modify that\n -configuration.\n +default one, entering its name here will allow you to load and modify\n +that configuration.\n \n -If you are uncertain, then you have probably never used alternate\n -configuration files. You should therefor leave this blank to abort.\n), +Leave empty to abort.\n), save_config_text[] = N_( Enter a filename to which this configuration should be saved\n -as an alternate. Leave blank to abort.), +as an alternate. Leave empty to abort.), save_config_help[] = N_( -\n -For various reasons, one may wish to keep different configurations\n -available on a single machine.\n +For various reasons, one may wish to keep several different\n +configurations available on a single machine.\n \n Entering a file name here will allow you to later retrieve, modify\n and use the current configuration as an alternate to whatever\n configuration options you have selected at that time.\n \n -If you are uncertain what all this means then you should probably\n -leave this blank.\n), +Leave empty to abort.\n), search_help[] = N_( -\n -Search for symbols and display their relations. Regular expressions\n -are allowed.\n -Example: search for \^FOO\\n +Search for symbols (configuration variable names CONFIG_*) and display\n +their relations. Regular expressions are supported.\n +Example: Search for \^FOO\.\n Result:\n -\n
Re: [PATCH resend v3 1/3] kconfig: nconf: rewrite help texts
On 2013-02-09 Saturday at 01:30 +0100 Yann E. MORIN wrote: Roland, All, I've taken that in my branch now. I will push later with a few fixes (see below). On Friday 01 February 2013 Roland Eggner wrote: [--SNIP--] diff --git a/scripts/kconfig/nconf.c b/scripts/kconfig/nconf.c --- a/scripts/kconfig/nconf.c +++ b/scripts/kconfig/nconf.c [--SNIP--] +o Global help: Unless in a data entry window, key F1 will give you\n ... pressing F1 ... +o A short version of the global help is available by key F3.\n ... by pressing F3 +o Local help: To get help related to the current menu entry, use any\n + of ? h keys, or if in a data entry window then use F1 key.\n s/ keys//; s/use F1 key/press F1/; +n to remove it. You may press the Space key to cycle through the\n ... press Space to cycle ... +Unless in a data entry window, key 1 may be used instead of F1,\n s/key //; +Enter the requested information and press Enter. Hexadecimal values\n +may be entered without \0x\ prefix.\n ... without the \0x\ prefix ... +Text Box (Help Window)\n +--\n +Use movement keys Down Up PageDown PageUp End Home as listed in\n +table above.\n ... keys [elided] as listed ... Ok, because you are dropping patch 3/3. +Alternate configuration files\n +-\n +nconfig supports switching between different configurations.\n +Use F6 to save your current configuration. Use F7 and enter a\n Press F6 ... Press F7 ... menu_no_f_instructions[] = N_( [--SNIP--] +Legend: [*] built-in [ ] excluded M modulemodule capable.\n +Submenus are designated by a trailing \---\.\n +\n +Use the following keys to navigate the menus:\n +Move up or down by any of Up Down keys.\n ... with Up or Down. +To enter a submenu use any of Enter Right keys.\n +To go back to the parent menu use any of Esc Left keys.\n Enter a submenu with Enter or Right. Exit a submenu to its parent menu with Esc or Left. +Pressing y includes, n excludes, m modularizes features.\n +Pressing Space cycles through the available options.\n +To search for menu entries use key /.\n ... press /. +Esc always leaves the current window.\n +\n +You do not have function keys support.\n +Use key 1 instead of F1, 2 instead of F2, etc.\n +For verbose global help use key 1.\n ... press 1. +For help related to the current menu entry use any of ? h keys.\n), ... press ? or h. And so on in the following... You performed a nice “polish“ … thank you! … … @@ -229,26 +222,26 @@ search_help[] = N_( Selects: LIBCRC32\n Selected by: BAR\n -\n -o The line 'Prompt:' shows the text used in the menu structure for\n - this symbol\n -o The 'Defined at' line tell at what file / line number the symbol\n - is defined\n -o The 'Depends on:' line tell what symbols needs to be defined for\n - this symbol to be visible in the menu (selectable)\n -o The 'Location:' lines tell where in the menu structure this symbol\n - is located\n -A location followed by a [ = y] indicate that this is a selectable\n -menu item - and current value is displayed inside brackets.\n -o The 'Selects:' line tell what symbol will be automatically\n - selected if this symbol is selected (y or m)\n -o The 'Selected by' line tell what symbol has selected this symbol\n +o The line 'Prompt:' shows the menu text displayed for this symbol in\n ... shows the [elided] text ... Any reason for the re-indent with one more space? Intention is optimization for fast reading, as usual in professional text processing: seperate words by single space; separate sentences, half-sentences and listing symbols by two spaces. + the menu hierarchy.\n +o The 'Defined at' line tells at what file / line number the symbol is\n ... file line ... +o The 'Depends on:' line tells, what symbols need to be defined for\n ... line lists symbols that need ... I will push soon to my branch. Thank you! -- Regards Roland Eggner pgpAS4zLdbqKk.pgp Description: PGP signature
Re: [PATCH resend v3 1/3] kconfig: nconf: rewrite help texts
>From: Roland Eggner
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 should document all _currently_ implemented
keybindings.
(2) Different help texts called by resp. 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
• SymSearch specific help called by followed by
(3) More reasonable window titles:
Rename window titles/README/Global help/
Rename variables/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
---
scripts/kconfig/nconf.c | 341 +++
1 files changed, 167 insertions(+), 174 deletions(-)
To be applied on vanilla 3.8-rc3
diff --git a/scripts/kconfig/nconf.c b/scripts/kconfig/nconf.c
--- a/scripts/kconfig/nconf.c
+++ b/scripts/kconfig/nconf.c
@@ -12,210 +12,203 @@
#include "nconf.h"
#include
-static const char nconf_readme[] = N_(
-"Overview\n"
-"\n"
-"This interface let you select features and parameters for the build.\n"
-"Features can either be built-in, modularized, or ignored. Parameters\n"
-"must be entered in as decimal or hexadecimal numbers or text.\n"
+static const char nconf_global_help[] = N_(
+"Help windows\n"
+"\n"
+"o Global help: Unless in a data entry window, key will give you\n"
+" the global help window, which you are just reading.\n"
"\n"
-"Menu items beginning with following braces represent features that\n"
-" [ ] can be built in or removed\n"
-" < > can be built in, modularized or removed\n"
-" { } can be built in or modularized (selected by other feature)\n"
-" - - are selected by other feature,\n"
-" XXX cannot be selected. Use Symbol Info to find out why,\n"
-"while *, M or whitespace inside braces means to build in, build as\n"
-"a module or to exclude the feature respectively.\n"
+"o A short version of the global help is available by key .\n"
"\n"
-"To change any of these features, highlight it with the cursor\n"
-"keys and press to build it in, to make it a module or\n"
-" to removed it. You may also press the to cycle\n"
-"through the available options (ie. Y->N->M->Y).\n"
+"o Local help: To get help related to the current menu entry, use any\n"
+" of keys, or if in a data entry window then use key.\n"
"\n"
-"Some additional keyboard hints:\n"
"\n"
-"Menus\n"
+"Menu entries\n"
+"\n"
+"This interface lets you select features and parameters for the kernel\n"
+"build. Kernel features can either be built-in, modularized, or removed.\n"
+"Parameters must be entered as text or decimal or hexadecimal numbers.\n"
+"\n"
+"Menu entries beginning with following braces represent features that\n"
+" [ ] can be built in or removed\n"
+" < > can be built in, modularized or removed\n"
+" { } can be built in or modularized, are selected by another feature\n"
+" - - are selected by another feature\n"
+" XXX cannot be selected. Symbol Info tells you why.\n"
+"*, M or whitespace inside braces means to build in, build as a module\n"
+"or to exclude the feature respectively.\n"
+"\n"
+"To change any of these features, highlight it with the movement keys\n"
+"listed below and press to build it in, to make it a module or\n"
+" to remove it. You may press the key to cycle through the\n"
+"available options.\n"
+"\n"
+"A trailing \"--->\" designates a submenu.\n"
+"\n"
+"\n"
+"Menu navigation keys\n"
+"--\n"
+"Linewise up \n"
+"Linewise down \n"
+"Pagewise up \n"
+"Pagewise down \n"
+"First entry \n"
+"Last entry \n"
+"Enter a submenu \n"
+"Go back to parent menu \n"
+"Close a help window \n"
+"Close entry window, apply \n"
+"Close entry window, forget\n"
+"Start incremental, case-insensitive search for STRING in menu entries,\n"
+"no regex support, STRING is displayed in upper left corner\n"
+"STRING\n"
+"Remove last character \n"
+"Jump to next hit\n"
+"Jump to previous hit\n"
+"Exit menu search mode \n"
+"Search for configuration variables with or without leading CONFIG_\n"
+"RegExpr\n"
+"Verbose search help \n"
+"--\n"
+"\n"
+"Unless in a data entry window, key <1> may be used instead of ,\n"
+"<2> instead of , etc.\n"
+"\n"
+"\n"
+"Radiolist (Choice list)\n"
+"---\n"
+"Use the movement keys listed above to select the option
Re: [PATCH resend v3 1/3] kconfig: nconf: rewrite help texts
From: Roland Eggner ed...@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. F8F1 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 titles/README/Global help/
Rename variables/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 ed...@systemanalysen.net
---
scripts/kconfig/nconf.c | 341 +++
1 files changed, 167 insertions(+), 174 deletions(-)
To be applied on vanilla 3.8-rc3
diff --git a/scripts/kconfig/nconf.c b/scripts/kconfig/nconf.c
--- a/scripts/kconfig/nconf.c
+++ b/scripts/kconfig/nconf.c
@@ -12,210 +12,203 @@
#include nconf.h
#include ctype.h
-static const char nconf_readme[] = N_(
-Overview\n
-\n
-This interface let you select features and parameters for the build.\n
-Features can either be built-in, modularized, or ignored. Parameters\n
-must be entered in as decimal or hexadecimal numbers or text.\n
+static const char nconf_global_help[] = N_(
+Help windows\n
+\n
+o Global help: Unless in a data entry window, key F1 will give you\n
+ the global help window, which you are just reading.\n
\n
-Menu items beginning with following braces represent features that\n
- [ ] can be built in or removed\n
-can be built in, modularized or removed\n
- { } can be built in or modularized (selected by other feature)\n
- - - are selected by other feature,\n
- XXX cannot be selected. Use Symbol Info to find out why,\n
-while *, M or whitespace inside braces means to build in, build as\n
-a module or to exclude the feature respectively.\n
+o A short version of the global help is available by key F3.\n
\n
-To change any of these features, highlight it with the cursor\n
-keys and press Y to build it in, M to make it a module or\n
-N to removed it. You may also press the Space Bar to cycle\n
-through the available options (ie. Y-N-M-Y).\n
+o Local help: To get help related to the current menu entry, use any\n
+ of ? h keys, or if in a data entry window then use F1 key.\n
\n
-Some additional keyboard hints:\n
\n
-Menus\n
+Menu entries\n
+\n
+This interface lets you select features and parameters for the kernel\n
+build. Kernel features can either be built-in, modularized, or removed.\n
+Parameters must be entered as text or decimal or hexadecimal numbers.\n
+\n
+Menu entries beginning with following braces represent features that\n
+ [ ] can be built in or removed\n
+ can be built in, modularized or removed\n
+ { } can be built in or modularized, are selected by another feature\n
+ - - are selected by another feature\n
+ XXX cannot be selected. Symbol Info F2 tells you why.\n
+*, M or whitespace inside braces means to build in, build as a module\n
+or to exclude the feature respectively.\n
+\n
+To change any of these features, highlight it with the movement keys\n
+listed below and press y to build it in, m to make it a module or\n
+n to remove it. You may press the Space key to cycle through the\n
+available options.\n
+\n
+A trailing \---\ designates a submenu.\n
+\n
+\n
+Menu navigation keys\n
+--\n
+Linewise up Up\n
+Linewise down Down\n
+Pagewise up Page Up\n
+Pagewise down Page Down\n
+First entry Home\n
+Last entry End\n
+Enter a submenu Right Enter\n
+Go back to parent menu Left Esc F5\n
+Close a help window Enter Esc F5\n
+Close entry window, apply Enter\n
+Close entry window, forget Esc F5\n
+Start incremental, case-insensitive search for STRING in menu entries,\n
+no regex support, STRING is displayed in upper left corner\n
+/STRING\n
+Remove last character Backspace\n
+Jump to next hitDown\n
+Jump to previous hitUp\n
+Exit menu search mode / Esc\n
+Search for configuration variables with or without leading CONFIG_\n
+F8RegExprEnter\n
+Verbose search help F8F1\n
+--\n
+\n
+Unless in a data entry window, key 1 may be used instead of F1,\n
+2 instead of F2, etc.\n
+\n
+\n
+Radiolist (Choice list)\n
+---\n
+Use the movement keys listed above to
