Linux Documentation
 help / color / mirror / Atom feed
From: Nathan Chancellor <nathan@kernel.org>
To: Stephen Brennan <stephen.s.brennan@oracle.com>
Cc: Jonathan Corbet <corbet@lwn.net>,
	Masahiro Yamada <masahiroy@kernel.org>,
	linux-doc@vger.kernel.org, linux-kbuild@vger.kernel.org,
	linux-kernel@vger.kernel.org, Nicolas Schier <nicolas@fjasle.eu>
Subject: Re: [PATCH v2] Documentation: kbuild: explicitly document missing prompt
Date: Fri, 23 Aug 2024 20:33:06 -0700	[thread overview]
Message-ID: <20240824033306.GC1733394@thelio-3990X> (raw)
In-Reply-To: <20240823194152.13881-1-stephen.s.brennan@oracle.com>

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
> 

  reply	other threads:[~2024-08-24  3:33 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-23 19:41 [PATCH v2] Documentation: kbuild: explicitly document missing prompt Stephen Brennan
2024-08-24  3:33 ` Nathan Chancellor [this message]
2024-09-05  0:01 ` Masahiro Yamada

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240824033306.GC1733394@thelio-3990X \
    --to=nathan@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kbuild@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=masahiroy@kernel.org \
    --cc=nicolas@fjasle.eu \
    --cc=stephen.s.brennan@oracle.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox