* [PATCH] kconfig: remove ---help--- from documentation
@ 2019-12-17 11:51 Masahiro Yamada
2019-12-18 14:16 ` Masahiro Yamada
0 siblings, 1 reply; 2+ messages in thread
From: Masahiro Yamada @ 2019-12-17 11:51 UTC (permalink / raw)
To: linux-kbuild
Cc: Ulf Magnusson, Masahiro Yamada, Jonathan Corbet, Michal Marek,
linux-doc, linux-kernel
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(-)
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
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] kconfig: remove ---help--- from documentation
2019-12-17 11:51 [PATCH] kconfig: remove ---help--- from documentation Masahiro Yamada
@ 2019-12-18 14:16 ` Masahiro Yamada
0 siblings, 0 replies; 2+ messages in thread
From: Masahiro Yamada @ 2019-12-18 14:16 UTC (permalink / raw)
To: Linux Kbuild mailing list
Cc: Ulf Magnusson, Jonathan Corbet, Michal Marek,
open list:DOCUMENTATION, Linux Kernel Mailing List
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
>
--
Best Regards
Masahiro Yamada
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2019-12-18 14:17 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-12-17 11:51 [PATCH] kconfig: remove ---help--- from documentation Masahiro Yamada
2019-12-18 14:16 ` Masahiro Yamada
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).