From 4b4f2da02cc2d1b76dfaf6cf01ac4eac665b8f6c Mon Sep 17 00:00:00 2001 From: Ulf Magnusson Date: Thu, 6 Dec 2012 21:42:38 +0100 Subject: Clarify documentation for 'Choice'. --- kconfiglib.py | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/kconfiglib.py b/kconfiglib.py index d609757..3e315d1 100644 --- a/kconfiglib.py +++ b/kconfiglib.py @@ -3102,13 +3102,21 @@ class Menu(Item): class Choice(Item, _HasVisibility): """Represents a choice statement. A choice can be in one of three modes: - "n", "m" and "y". "n" mode is for non-visible choices and optional choices - with no symbol selected; "m" means any number of symbols can be set to "m" - while the rest will be "n" (only tristate choices can be in this mode); and - "y" means one symbol will be "y" while the rest will be "n" (the most - common case). The visibility is an upper bound on the mode, and the mode - changes automatically as values are assigned to symbols within the - choice.""" + + "n" - The choice is not visible and no symbols can be selected. + + "m" - Any number of symbols can be set to "m". The rest will be "n". This + is safe since potentially conflicting options don't actually get + compiled into the kernel simultaneously with "m". + + "y" - One symbol will be "y" while the rest are "n". + + Only tristate choices can be in "m" mode, and the visibility of the choice + is an upper bound on the mode, so that e.g. a choice that depends on a + symbol with value "m" will be in "m" mode. + + The mode changes automatically when a value is assigned to a symbol within + the choice.""" # # Public interface -- cgit v1.2.3