Skip to contentSkip to conversation

kconfig language doc r.e. --help--

trivial 2.5 Stewart Smith 2 participants 4 messages Jun 25, 2003

Subsystems (3)
Documentation Kbuild Kconfig
lore
Share & tools
lore

Stewart Smith

author
#0 lore raw

How does this read? hopefully it makes sense :)

Documentation/kbuild/kconfig-language.txt +3 -0
@@ -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
Signature · 3 lines
Stewart Smith
Vice President, Linux Australia
http://www.linux.org.au (personal: http://www.flamingspork.com)
#1 lore raw

Hi,

Documentation/kbuild/kconfig-language.txt line 114

Quoted 9 lines · Stewart Smith
Documentation/kbuild/kconfig-language.txt +3 -0
@@ -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

author
#2 lore raw
Quoted 2 lines · Roman Zippel

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.

Documentation/kbuild/kconfig-language.txt +4 -1
@@ -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
Signature · 3 lines
Stewart Smith
Vice President, Linux Australia
http://www.linux.org.au (personal: http://www.flamingspork.com)
#3 lore raw

Hi,

Quoted 4 lines · Stewart Smith
Documentation/kbuild/kconfig-language.txt +0 -0
@@ -105,10 +105,13 @@
   or equal to the first symbol and smaller than or equal to the second

Documentation/kbuild/kconfig-language.txt line 114

Quoted 10 lines
Documentation/kbuild/kconfig-language.txt +4 -1
   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