diff options
| author | Masahiro Yamada <masahiroy@kernel.org> | 2019-12-17 14:51:51 +0300 |
|---|---|---|
| committer | Masahiro Yamada <masahiroy@kernel.org> | 2019-12-18 17:17:29 +0300 |
| commit | 8f268881d7d278047b00eed54bbb9288dbd6ab23 (patch) | |
| tree | f5c4bc6c07cc41f68b6316764c8676b17bfff684 /Documentation/kbuild | |
| parent | a11391b6f50689adb22c65df783e09143fafb794 (diff) | |
| download | linux-8f268881d7d278047b00eed54bbb9288dbd6ab23.tar.xz | |
kconfig: remove ---help--- from documentation
Since commit 84af7a6194e4 ("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 <masahiroy@kernel.org>
Diffstat (limited to 'Documentation/kbuild')
| -rw-r--r-- | Documentation/kbuild/kconfig-language.rst | 5 |
1 files changed, 1 insertions, 4 deletions
diff --git a/Documentation/kbuild/kconfig-language.rst b/Documentation/kbuild/kconfig-language.rst index 74bef19f69f0..231e6a64957f 100644 --- a/Documentation/kbuild/kconfig-language.rst +++ b/Documentation/kbuild/kconfig-language.rst @@ -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>] |