| Message ID | 20240823194152.13881-1-stephen.s.brennan@oracle.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | [v2] Documentation: kbuild: explicitly document missing prompt | expand |
On Fri, Aug 23, 2024 at 12:41:51PM -0700, Stephen Brennan wrote: > There are a few lines in the kbuild-language.rst document which > obliquely reference the behavior of config options without prompts. > But there is nothing in the obvious location that explicitly calls > out that users cannot edit config options unless they have a prompt. > > Signed-off-by: Stephen Brennan <stephen.s.brennan@oracle.com> Looks good to me. Reviewed-by: Nathan Chancellor <nathan@kernel.org> > --- > v1: https://lore.kernel.org/linux-doc/20240820171000.1656021-1-stephen.s.brennan@oracle.com/ > > Documentation/kbuild/kconfig-language.rst | 6 +++++- > 1 file changed, 5 insertions(+), 1 deletion(-) > > diff --git a/Documentation/kbuild/kconfig-language.rst b/Documentation/kbuild/kconfig-language.rst > index 1fb3f5e6193c3..4650daaf5d365 100644 > --- a/Documentation/kbuild/kconfig-language.rst > +++ b/Documentation/kbuild/kconfig-language.rst > @@ -70,7 +70,11 @@ applicable everywhere (see syntax). > > Every menu entry can have at most one prompt, which is used to display > to the user. Optionally dependencies only for this prompt can be added > - with "if". > + with "if". If a prompt is not present, the config option is a non-visible > + symbol, meaning its value cannot be directly changed by the user (such as > + altering the value in ``.config``) and the option will not appear in any > + config menus. Its value can only be set via "default" and "select" (see > + below). > > - default value: "default" <expr> ["if" <expr>] > > -- > 2.43.5 >
On Sat, Aug 24, 2024 at 4:42 AM Stephen Brennan <stephen.s.brennan@oracle.com> wrote: > > There are a few lines in the kbuild-language.rst document which > obliquely reference the behavior of config options without prompts. > But there is nothing in the obvious location that explicitly calls > out that users cannot edit config options unless they have a prompt. > > Signed-off-by: Stephen Brennan <stephen.s.brennan@oracle.com> > --- > v1: https://lore.kernel.org/linux-doc/20240820171000.1656021-1-stephen.s.brennan@oracle.com/ Applied to linux-kbuild. Thanks! > > Documentation/kbuild/kconfig-language.rst | 6 +++++- > 1 file changed, 5 insertions(+), 1 deletion(-) > > diff --git a/Documentation/kbuild/kconfig-language.rst b/Documentation/kbuild/kconfig-language.rst > index 1fb3f5e6193c3..4650daaf5d365 100644 > --- a/Documentation/kbuild/kconfig-language.rst > +++ b/Documentation/kbuild/kconfig-language.rst > @@ -70,7 +70,11 @@ applicable everywhere (see syntax). > > Every menu entry can have at most one prompt, which is used to display > to the user. Optionally dependencies only for this prompt can be added > - with "if". > + with "if". If a prompt is not present, the config option is a non-visible > + symbol, meaning its value cannot be directly changed by the user (such as > + altering the value in ``.config``) and the option will not appear in any > + config menus. Its value can only be set via "default" and "select" (see > + below). > > - default value: "default" <expr> ["if" <expr>] > > -- > 2.43.5 >
diff --git a/Documentation/kbuild/kconfig-language.rst b/Documentation/kbuild/kconfig-language.rst index 1fb3f5e6193c3..4650daaf5d365 100644 --- a/Documentation/kbuild/kconfig-language.rst +++ b/Documentation/kbuild/kconfig-language.rst @@ -70,7 +70,11 @@ applicable everywhere (see syntax). Every menu entry can have at most one prompt, which is used to display to the user. Optionally dependencies only for this prompt can be added - with "if". + with "if". If a prompt is not present, the config option is a non-visible + symbol, meaning its value cannot be directly changed by the user (such as + altering the value in ``.config``) and the option will not appear in any + config menus. Its value can only be set via "default" and "select" (see + below). - default value: "default" <expr> ["if" <expr>]
There are a few lines in the kbuild-language.rst document which obliquely reference the behavior of config options without prompts. But there is nothing in the obvious location that explicitly calls out that users cannot edit config options unless they have a prompt. Signed-off-by: Stephen Brennan <stephen.s.brennan@oracle.com> --- v1: https://lore.kernel.org/linux-doc/20240820171000.1656021-1-stephen.s.brennan@oracle.com/ Documentation/kbuild/kconfig-language.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)