documentation update
[tiramisu.git] / doc / glossary.txt
1 .. default-role:: literal
2
3 Glossary
4 ==========
5
6 .. glossary::
7
8     configuration
9
10         Global configuration object, wich contains the whole configuration
11         options *and* their descriptions (option types and group)
12
13 .. glossary::
14
15     schema
16     option description
17
18         see :class:`tiramisu.option.OptionDescription`
19
20         The schema of a configuration :
21
22         - the option types
23
24         - how they are organised in groups or even subgroups, that's why we
25           call them **groups** too.
26
27 .. glossary::
28
29     configuration option
30
31         An option object wich has a name and a value and can be accessed
32         from the configuration object
33
34 .. glossary::
35
36     default value
37
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`
41
42 .. glossary::
43
44     acces rules
45
46         Access rules are : `config.Config.read_write()` or
47         `config.Config.read_only()`, see :doc:`status`
48
49 .. glossary::
50
51     freeze
52
53         A whole configuration can be frozen (used in read only access). See
54         `status#frozenconfig` for details.
55
56         A single option can be frozen too.
57
58 .. glossary::
59
60     forced on freeze
61
62         A single option is frozen and we want the option to return something
63         else than his value, typically his default value, see
64         `status#frozen`
65
66 .. glossary::
67
68     value owner
69
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.
73
74 .. glossary::
75
76     option with properties
77
78         an option wich has property like 'hidden' or 'disabled' is an option
79         wich has restricted acces rules
80
81 .. glossary::
82
83     hidden option
84
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.
87
88 .. glossary::
89
90     disabled option
91
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.
94
95 .. glossary::
96
97     mandatory option
98
99         A mandatory option is a configuration option wich value has to be
100         set, that is the default value cannot be `None`.
101
102 .. glossary::
103
104     consistency
105
106         Preserve the consistency in a whole configuration is a tricky thing,
107         tiramisu takes care of it for you, see :doc:`consistency` for details.