1 .. default-role:: literal
10 Global configuration object, wich contains the whole configuration
11 options *and* their descriptions (option types and group)
13 .. _`option description`:
17 **option description**
19 see :api:`option.OptionDescription`, see :ref:`optionapi#schema`
21 The schema of a configuration :
25 - how they are organised in groups or even subgroups, that's why we
26 call them **groups** too.
30 **configuration option**
32 An option object wich has a name and a value and can be accessed
33 from the configuration object
39 Default value of a configuration option. The default value can be
40 set at instanciation time, or even at any moment. Remember that if
41 you reset the default value, the owner reset to `default`
47 Access rules are : :api:`config.Config.cfgimpl_read_write()` or
48 :api:`config.Config.cfgimpl_read_only()`, see :doc:`status`
52 A whole configuration can be frozen (used in read only access). See
53 :doc:`status` for details.
59 When an option is modified, including at the instanciation, we
60 always know who has modified it. It's the owner of the option, see
61 :doc:`status` for more details.
65 a hidden option has a different behaviour on regards to the access
66 of the value in the configuration, see :doc:`status` for more details.
70 a disabled option has a different behaviour on regards to the access
71 of the value in the configuration, see :doc:`status` for more details.
75 a fill option is like an automatic option except that it is
76 calculated only if a value hasn't been set.
80 an automatic option is an option thas is carried out by an external
87 A mandatory option is a configuration option wich value has to be
88 set, that is the default value cannot be `None`, see
89 :ref:`optionapi#optioninit`
96 Preserve the consistency in a whole configuration is a tricky thing,
97 tiramisu takes care of it for you, see :doc:`consistency` for details.