Commit 8f268881 authored by Masahiro Yamada's avatar Masahiro Yamada
Browse files

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



Since commit 84af7a61 ("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: default avatarMasahiro Yamada <masahiroy@kernel.org>
parent a11391b6
Loading
Loading
Loading
Loading
+1 −4
Original line number Diff line number Diff line
@@ -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>]