linux-kernel - Re: [PATCH v2] Documentation: kbuild: explicitly document missing prompt

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20240824033306.GC1733394@thelio-3990X>
Date: Fri, 23 Aug 2024 20:33:06 -0700
From: Nathan Chancellor <nathan@...nel.org>
To: Stephen Brennan <stephen.s.brennan@...cle.com>
Cc: Jonathan Corbet <corbet@....net>,
	Masahiro Yamada <masahiroy@...nel.org>, linux-doc@...r.kernel.org,
	linux-kbuild@...r.kernel.org, linux-kernel@...r.kernel.org,
	Nicolas Schier <nicolas@...sle.eu>
Subject: Re: [PATCH v2] Documentation: kbuild: explicitly document missing
 prompt

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@...cle.com>

Looks good to me.

Reviewed-by: Nathan Chancellor <nathan@...nel.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
>