From 6aaf01c241b1356c1c8ceb3425f355f448bb4224 Mon Sep 17 00:00:00 2001 From: Ulf Magnusson Date: Tue, 2 Oct 2018 00:57:02 +0200 Subject: Clean up documentation a bit re. named choice Zephyr uses several named choices, and I've seen them in other projects now too, so don't imply that they aren't used. The menuconfig interface now has better support for them than the C tools too, where adding symbols by defining a choice in multiple locations is broken. Also remove a reference to Kconfiglib 1. --- kconfiglib.py | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) (limited to 'kconfiglib.py') diff --git a/kconfiglib.py b/kconfiglib.py index 11335b3..15a92cd 100644 --- a/kconfiglib.py +++ b/kconfiglib.py @@ -4292,8 +4292,7 @@ class Choice(object): name: The name of the choice, e.g. "FOO" for 'choice FOO', or None if the - Choice has no name. I can't remember ever seeing named choices in - practice, but the C tools support them too. + Choice has no name. type: The type of the choice. One of BOOL, TRISTATE, UNKNOWN. UNKNOWN is for @@ -4380,17 +4379,14 @@ class Choice(object): syms: List of symbols contained in the choice. - Gotcha: If a symbol depends on the previous symbol within a choice so - that an implicit menu is created, it won't be a choice symbol, and won't - be included in 'syms'. There are real-world examples of this, and it was - a PITA to support in older versions of Kconfiglib that didn't implement - the menu structure. + Obscure gotcha: If a symbol depends on the previous symbol within a + choice so that an implicit menu is created, it won't be a choice symbol, + and won't be included in 'syms'. nodes: A list of MenuNodes for this choice. In practice, the list will probably always contain a single MenuNode, but it is possible to give a choice a - name and define it in multiple locations (I've never even seen a named - choice though). + name and define it in multiple locations. defaults: List of (symbol, cond) tuples for the choice's 'defaults' properties. For -- cgit v1.2.3