linux-kernel - Re: [PATCH resend v3 1/3] kconfig: nconf: rewrite help texts

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20130209034609.GA8891@mobil.systemanalysen.net>
Date:	Sat, 9 Feb 2013 04:46:09 +0100
From:	Roland Eggner <edvx1@...temanalysen.net>
To:	"Yann E. MORIN" <yann.morin.1998@...e.fr>
Cc:	linux-kbuild@...r.kernel.org, Dmitry Voytik <dvv.kernel@...il.com>,
	Michal Marek <mmarek@...e.cz>,
	Stephen Boyd <sboyd@...eaurora.org>,
	linux-kernel@...r.kernel.org
Subject: 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> 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 <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

Content of type "application/pgp-signature" skipped