Skip to content

Commit 8f26888

Browse files
committed
kconfig: remove ---help--- from documentation
Since commit 84af7a6 ("checkpatch: kconfig: prefer 'help' over '---help---'"), scripts/checkpatch.pl warns the use of ---help---. Kconfig still supports ---help---, but new code should avoid using it. Let's stop advertising it in documentation. Signed-off-by: Masahiro Yamada <[email protected]>
1 parent a11391b commit 8f26888

File tree

1 file changed

+1
-4
lines changed

1 file changed

+1
-4
lines changed

Documentation/kbuild/kconfig-language.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -196,14 +196,11 @@ applicable everywhere (see syntax).
196196
or equal to the first symbol and smaller than or equal to the second
197197
symbol.
198198

199-
- help text: "help" or "---help---"
199+
- help text: "help"
200200

201201
This defines a help text. The end of the help text is determined by
202202
the indentation level, this means it ends at the first line which has
203203
a smaller indentation than the first line of the help text.
204-
"---help---" and "help" do not differ in behaviour, "---help---" is
205-
used to help visually separate configuration logic from help within
206-
the file as an aid to developers.
207204

208205
- misc options: "option" <symbol>[=<value>]
209206

0 commit comments

Comments
 (0)