kconfig: remove ---help--- from documentation
diff mbox series

Message ID 20191217115151.12465-1-masahiroy@kernel.org
State New
Headers show
Series
  • kconfig: remove ---help--- from documentation
Related show

Commit Message

Masahiro Yamada Dec. 17, 2019, 11:51 a.m. UTC
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.

Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
---

 Documentation/kbuild/kconfig-language.rst | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)

Comments

Masahiro Yamada Dec. 18, 2019, 2:16 p.m. UTC | #1
On Tue, Dec 17, 2019 at 8:52 PM Masahiro Yamada <masahiroy@kernel.org> wrote:
>
> 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.
>
> Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
> ---

Applied to linux-kbuild.

>
>  Documentation/kbuild/kconfig-language.rst | 5 +----
>  1 file changed, 1 insertion(+), 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>]
>
> --
> 2.17.1
>

Patch
diff mbox series

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>]