summaryrefslogtreecommitdiff
path: root/kconfiglib.py
diff options
context:
space:
mode:
authorUlf Magnusson <ulfalizer@gmail.com>2012-12-11 05:41:55 +0100
committerUlf Magnusson <ulfalizer@gmail.com>2012-12-11 05:41:55 +0100
commit6533806afb9bc2fd9660c3116eacdb7f20b43665 (patch)
treebe2669023d830d68469f2015e1ca8a89f5b687e9 /kconfiglib.py
parent883ae46e8a120d6dda03a4a56a544ab79cf20b3b (diff)
Expand set_value() documentation.
Diffstat (limited to 'kconfiglib.py')
-rw-r--r--kconfiglib.py17
1 files changed, 11 insertions, 6 deletions
diff --git a/kconfiglib.py b/kconfiglib.py
index e1c4baa..a6ff7c5 100644
--- a/kconfiglib.py
+++ b/kconfiglib.py
@@ -2440,14 +2440,19 @@ class Symbol(Item, _HasVisibility):
def set_value(self, v):
"""Sets the (user) value of the symbol. Equal in effect to assigning
the value to the symbol within a .config file. Use
- get_lower/upper_bound() to find the range of valid values for bool and
- tristate symbols; setting values outside this range will cause the user
- value to differ from the result of Symbol.calc_value(). Any value that
- is valid for the type (bool, tristate, etc.) will end up being
- reflected in Symbol.get_user_value() though.
+ get_lower/upper_bound() or get_assignable_values() to find the range of
+ valid values for bool and tristate symbols; setting values outside this
+ range will cause the user value to differ from the result of
+ Symbol.calc_value() (be truncated).
+
+ For any type of symbol, is_modifiable() can be used to check if a user
+ value will have any effect on the symbol, as determined by its
+ visibility and range of assignable values. Any value that is valid for
+ the type (bool, tristate, etc.) will end up being reflected in
+ Symbol.get_user_value() though.
Any symbols dependent on the symbol are (recursively) invalidated, so
- things should just work with regards to dependencies.
+ things will just work with regards to dependencies.
v -- The value to give to the symbol."""
self._set_value_no_invalidate(v, False)