06f0616f87e101f7cc59bca60efbcc9236b31653
[tiramisu.git] / doc / glossary.txt
1 .. default-role:: literal
2
3 glossary
4 ==========
5
6 .. _configuration:
7
8 **configuration**
9
10     Global configuration object, wich contains the whole configuration 
11     options *and* their descriptions (option types and group)
12
13 .. _`option description`:
14 .. _`schema`:
15
16 **schema**:
17 **option description**
18
19     see :api:`option.OptionDescription`, see :ref:`optionapi#schema`
20
21     The schema of a configuration : 
22     
23     - the option types
24
25     - how they are organised in groups or even subgroups, that's why we 
26       call them **groups** too.
27
28 .. _`configoption`:
29
30 **configuration option**
31
32     An option object wich has a name and a value and can be accessed 
33     from the configuration object
34
35 .. _`defaultvalue`:
36
37 **default value**
38
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`
42
43 .. _`rules`:
44
45 **acces rules**
46     
47     Access rules are : :api:`config.Config.cfgimpl_read_write()` or 
48     :api:`config.Config.cfgimpl_read_only()`, see :doc:`status` 
49
50 **freeze**
51
52     A whole configuration can be frozen (used in read only access). See 
53     :doc:`status` for details.
54
55 .. _`valueowner`: 
56
57 **value owner** 
58     
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.
62
63 **hidden option**
64
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.
67
68 **disabled option**
69
70     FIXME
71
72 **fill option**
73
74     FIXME
75     
76 **auto option**
77
78     FIXME
79
80 .. _mandatory:
81
82 **mandatory option**
83
84     A mandatory option is a configuration option wich value has to be 
85     set, that is the default value cannot be `None`, see 
86     :ref:`optionapi#optioninit`
87     
88     
89 .. _consistency:
90
91 **consistency**
92
93     Preserve the consistency in a whole configuration is a tricky thing,
94     tiramisu takes care of it for you, see :doc:`consistency` for details.