[trivial 2.5] kconfig language doc r.e. --help--

[trivial 2.5] kconfig language doc r.e. --help--

[Stewart Smith]

How does this read? hopefully it makes sense :)

--- linux-2.5.73/Documentation/kbuild/kconfig-language.txt	2003-06-15 17:47:18.000000000 +1000
+++ linux-2.5.73-stew1/Documentation/kbuild/kconfig-language.txt	2003-06-25 18:38:49.000000000 +1000
@@ -109,6 +109,8 @@
   This defines a help text. The end of the help text is determined by
   the indentation level, this means it ends at the first line which has
   a smaller indentation than the first line of the help text.
+  You may also use dashes around the word help to assist in the visual
+  separation of help from configuration. e.g. '--help--' or '---help---'.
+  These dashes have no effect on functionality, they are purely decorative.
 
 Menu dependencies


-- 
Stewart Smith
Vice President, Linux Australia
http://www.linux.org.au (personal: http://www.flamingspork.com)

Re: [trivial 2.5] kconfig language doc r.e. --help--

[Roman Zippel]

Hi,

On Wed, 25 Jun 2003, Stewart Smith wrote:

> --- linux-2.5.73/Documentation/kbuild/kconfig-language.txt	2003-06-15 17:47:18.000000000 +1000
> +++ linux-2.5.73-stew1/Documentation/kbuild/kconfig-language.txt	2003-06-25 18:38:49.000000000 +1000
> @@ -109,6 +109,8 @@
>    This defines a help text. The end of the help text is determined by
>    the indentation level, this means it ends at the first line which has
>    a smaller indentation than the first line of the help text.
> +  You may also use dashes around the word help to assist in the visual
> +  separation of help from configuration. e.g. '--help--' or '---help---'.
> +  These dashes have no effect on functionality, they are purely decorative.

Where did you find the '--help--' version? I'm actually suprised that 
works. The official alternative is only '---help---'.

bye, Roman

Re: [trivial 2.5] kconfig language doc r.e. --help--

[Stewart Smith]

On Wed, Jun 25, 2003 at 12:48:43PM +0200, Roman Zippel wrote:
> Where did you find the '--help--' version? I'm actually suprised that 
> works. The official alternative is only '---help---'.

I'd *swear* i saw '--help--' yesterday. I'd swear until i was a
light shade of blue....  

Oh well, patch that only references "---help---" below.


--- linux-2.5.73/Documentation/kbuild/kconfig-language.txt	2003-06-15 17:47:18.000000000 +1000
+++ linux-2.5.73-stew1/Documentation/kbuild/kconfig-language.txt	2003-06-25 21:24:28.000000000 +1000
@@ -105,10 +105,13 @@
   or equal to the first symbol and smaller than or equal to the second
   symbol.
 
-- help text: "help"
+- help text: "help" or "---help---"
   This defines a help text. The end of the help text is determined by
   the indentation level, this means it ends at the first line which has
   a smaller indentation than the first line of the help text.
+  "---help---" and "help" do not differ in behaviour, "---help---" is
+  used to help visually seperate configuration logic from help within
+  the file as an aid to developers.
 
 
 Menu dependencies


-- 
Stewart Smith
Vice President, Linux Australia
http://www.linux.org.au (personal: http://www.flamingspork.com)

Re: [trivial 2.5] kconfig language doc r.e. --help--

[Roman Zippel]

Hi,

On Wed, 25 Jun 2003, Stewart Smith wrote:

> --- linux-2.5.73/Documentation/kbuild/kconfig-language.txt	2003-06-15 17:47:18.000000000 +1000
> +++ linux-2.5.73-stew1/Documentation/kbuild/kconfig-language.txt	2003-06-25 21:24:28.000000000 +1000
> @@ -105,10 +105,13 @@
>    or equal to the first symbol and smaller than or equal to the second
>    symbol.
>  
> -- help text: "help"
> +- help text: "help" or "---help---"
>    This defines a help text. The end of the help text is determined by
>    the indentation level, this means it ends at the first line which has
>    a smaller indentation than the first line of the help text.
> +  "---help---" and "help" do not differ in behaviour, "---help---" is
> +  used to help visually seperate configuration logic from help within
> +  the file as an aid to developers.

Looks fine, thanks.

bye, Roman