Skip to contentSkip to conversation

kconfig: remove ---help--- from documentation

PATCH In review Masahiro Yamada 1 participant 2 messages Dec 17, 2019 – Dec 18, 2019

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 kconfig: remove ---help--- from documentation

Commit 84af7a6194e4 ("checkpatch: kconfig: prefer 'help' over '---help---'"), scripts/checkpatch.pl warns the use of ---help---.

This still exists, but new code should avoid using it. Let's stop advertising it in documentation.

---

 Documentation/kbuild/kconfig-language.rst | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)
Documentation/kbuild/kconfig-language.rst +1 -4
index 74bef19f69f0..231e6a64957f 100644
@@ -196,14 +196,11 @@ applicable everywhere (see syntax).
   or equal to the first symbol and smaller than or equal to the second
   symbol.
 
-- help text: "help" or "---help---"
+- help text: "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 separate configuration logic from help within
-  the file as an aid to developers.
 
 - misc options: "option" <symbol>[=<value>]
 
Signature · 1 line
2.17.1
#1 lore raw
Quoted 9 lines · Masahiro Yamada

Commit 84af7a6194e4 ("checkpatch: kconfig: prefer 'help' over '---help---'"), scripts/checkpatch.pl warns the use of ---help---.

This still exists, but new code should avoid using it. Let's stop advertising it in documentation.

---

Applied to linux-kbuild.

Quoted 27 lines
 Documentation/kbuild/kconfig-language.rst | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)
Documentation/kbuild/kconfig-language.rst +1 -5
index 74bef19f69f0..231e6a64957f 100644
@@ -196,14 +196,11 @@ applicable everywhere (see syntax).
   or equal to the first symbol and smaller than or equal to the second
   symbol.
 
-- help text: "help" or "---help---"
+- help text: "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 separate configuration logic from help within
-  the file as an aid to developers.
 
 - misc options: "option" <symbol>[=<value>]
 
--

2.17.1

Signature · 2 lines
Best Regards
Masahiro Yamada