1 .. default-role:: literal
10 Global configuration object, wich contains the whole configuration
11 options *and* their descriptions (option types and group)
18 see `option.OptionDescription`, see `option#schema`
20 The schema of a configuration :
24 - how they are organised in groups or even subgroups, that's why we
25 call them **groups** too.
31 An option object wich has a name and a value and can be accessed
32 from the configuration object
38 Default value of a configuration option. The default value can be
39 set at instanciation time, or even at any moment. Remember that if
40 you reset the default value, the owner reset to `default`
46 Access rules are : `config.Config.read_write()` or
47 `config.Config.read_only()`, see :doc:`status`
53 A whole configuration can be frozen (used in read only access). See
54 `status#frozenconfig` for details.
56 A single option can be frozen too.
62 A single option is frozen and we want the option to return something
63 else than his value, typically his default value, see
70 When an option is modified, including at the instanciation, we
71 always know who has modified it. It's the owner of the option, see
72 :doc:`status` for more details.
76 option with properties
78 an option wich has property like 'hidden' or 'disabled' is an option
79 wich has restricted acces rules
85 a hidden option has a different behaviour on regards to the access
86 of the value in the configuration, see :doc:`status` for more details.
92 a disabled option has a different behaviour on regards to the access
93 of the value in the configuration, see :doc:`status` for more details.
99 A mandatory option is a configuration option wich value has to be
100 set, that is the default value cannot be `None`, see
101 `optionapi#optioninit`
107 Preserve the consistency in a whole configuration is a tricky thing,
108 tiramisu takes care of it for you, see :doc:`consistency` for details.