LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Robert Richter <rrichter@amd.com>
To: Masahiro Yamada <masahiroy@kernel.org>
Cc: Michal Marek <michal.lkml@markovi.net>,
	Jonathan Corbet <corbet@lwn.net>,
	Linux Kbuild mailing list <linux-kbuild@vger.kernel.org>,
	"open list:DOCUMENTATION" <linux-doc@vger.kernel.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Subject: [PATCH v2] Documentation/kbuild: Document the kconfig choice default value
Date: Mon, 19 Jul 2021 11:16:01 +0200	[thread overview]
Message-ID: <YPVC0Xs0gRSywTO7@rric.localdomain> (raw)
In-Reply-To: <CAK7LNAQpTBb8gyESBxzUcrz6vKw1MecnB5=xPd-CYfSFCC4hgA@mail.gmail.com>

On 18.07.21 18:36:31, Masahiro Yamada wrote:
> On Thu, Jul 15, 2021 at 6:26 PM Robert Richter <rrichter@amd.com> wrote:

> > --- a/Documentation/kbuild/kconfig-language.rst
> > +++ b/Documentation/kbuild/kconfig-language.rst
> > @@ -417,6 +417,9 @@ definitions of that choice. If a [symbol] is associated to the choice,
> >  then you may define the same choice (i.e. with the same entries) in another
> >  place.
> >
> > +The default value of a choice is set to the first visible choice element.
> 
> 
> The default value of a choice is set to the first visible choice element
> unless it is explicitly set by the 'default' property.
> 
> ... is more precise.

Ah, ok. It becomes clear now, but how a value is set then in case the
type is tristate?

> 
> 
> 
> 
> > +Choice elements do not support the default attribute like menu entries do.
> 
> I doubt this info is useful.
> Rather, is it even confusing?
> 
> 
> choices support 'default' but
> choice elements (i.e. choice values) do not.

I have added an example to the doc for clarification, v2 below.

Thanks,

-Robert


From 46ebd10dc11388ddce40aea70890000697a27165 Mon Sep 17 00:00:00 2001
From: Robert Richter <rrichter@amd.com>
Date: Wed, 14 Jul 2021 12:24:16 +0200
Subject: [PATCH v2] Documentation/kbuild: Document the kconfig choice default
 value

Document how choice defaults are determined:

Default of a choice is its first visible choice element unless it is
explicitly set by the 'default' property [1]. Choice elements do not
support default attributes. [2]

[1] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/scripts/kconfig/symbol.c?h=v5.14-rc1#n245
[2] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/scripts/kconfig/menu.c?h=v5.14-rc1#n494

Signed-off-by: Robert Richter <rrichter@amd.com>
---
v2: clarification on 'default' attribute of a choice
    added example
---
 Documentation/kbuild/kconfig-language.rst | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/Documentation/kbuild/kconfig-language.rst b/Documentation/kbuild/kconfig-language.rst
index e4d3463594e1..d919dde0bcbf 100644
--- a/Documentation/kbuild/kconfig-language.rst
+++ b/Documentation/kbuild/kconfig-language.rst
@@ -417,8 +417,20 @@ definitions of that choice. If a [symbol] is associated to the choice,
 then you may define the same choice (i.e. with the same entries) in another
 place.
 
-The default value of a choice is set to the first visible choice element.
-Choice elements do not support the default attribute like menu entries do.
+The default value of a choice is set to the first visible choice
+element unless it is explicitly set by the 'default' property.
+
+Note:
+	Choice options do not support the 'default' attribute.
+
+E.g.::
+
+  choice
+	default C1
+  config C0
+  config C1
+	# no default attribute here
+  endchoice
 
 comment::
 
-- 
2.29.2


  reply	other threads:[~2021-07-19  9:16 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-15  9:26 [PATCH] ACPI: Kconfig: Fix table override from built-in initrd Robert Richter
2021-07-15  9:26 ` [PATCH] Documentation: Fix intiramfs script name Robert Richter
2021-07-18 13:58   ` Masahiro Yamada
2021-07-15  9:26 ` [PATCH] Documentation/kbuild: Document the kconfig choice default value Robert Richter
2021-07-18  9:36   ` Masahiro Yamada
2021-07-19  9:16     ` Robert Richter [this message]
2021-07-19 20:20       ` [PATCH v2] " Robert Richter
2021-07-19 20:28         ` [PATCH v3] " Robert Richter
2021-08-05 12:47           ` Masahiro Yamada
2021-07-16 17:29 ` [PATCH] ACPI: Kconfig: Fix table override from built-in initrd Rafael J. Wysocki

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=YPVC0Xs0gRSywTO7@rric.localdomain \
    --to=rrichter@amd.com \
    --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=michal.lkml@markovi.net \
    --subject='Re: [PATCH v2] Documentation/kbuild: Document the kconfig choice default value' \
    /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

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).