tiramisu/doc/glossary.txt

109 lines
2.6 KiB
Plaintext
Raw Normal View History

.. default-role:: literal
glossary
==========
2012-11-20 17:14:58 +01:00
.. glossary::
2012-11-20 17:14:58 +01:00
configuration
2012-11-20 17:14:58 +01:00
Global configuration object, wich contains the whole configuration
options *and* their descriptions (option types and group)
2012-11-20 17:14:58 +01:00
.. glossary::
2012-11-20 17:14:58 +01:00
schema
option description
see `option.OptionDescription`, see `option#schema`
2012-11-20 17:14:58 +01:00
The schema of a configuration :
2012-11-20 17:14:58 +01:00
- the option types
2012-11-20 17:14:58 +01:00
- how they are organised in groups or even subgroups, that's why we
call them **groups** too.
2012-11-20 17:14:58 +01:00
.. glossary::
2012-11-20 17:14:58 +01:00
configuration option
2012-11-20 17:14:58 +01:00
An option object wich has a name and a value and can be accessed
from the configuration object
2012-11-20 17:14:58 +01:00
.. glossary::
2012-11-20 17:14:58 +01:00
default value
2012-11-20 17:14:58 +01:00
Default value of a configuration option. The default value can be
set at instanciation time, or even at any moment. Remember that if
you reset the default value, the owner reset to `default`
2012-11-20 17:14:58 +01:00
.. glossary::
2012-11-20 17:14:58 +01:00
acces rules
2012-11-20 17:14:58 +01:00
Access rules are : `config.Config.cfgimpl_read_write()` or
`config.Config.cfgimpl_read_only()`, see :doc:`status`
2012-11-20 17:14:58 +01:00
.. glossary::
2012-11-20 17:14:58 +01:00
freeze
2012-11-20 17:14:58 +01:00
A whole configuration can be frozen (used in read only access). See
`status#frozenconfig` for details.
2012-11-20 17:14:58 +01:00
A single option can be frozen too.
2012-11-20 17:14:58 +01:00
.. glossary::
2012-11-20 17:14:58 +01:00
forced on freeze
2012-11-20 17:14:58 +01:00
A single option is frozen and we want the option to return something
else than his value, typically his default value, see
`status#frozen`
2012-11-20 17:14:58 +01:00
.. glossary::
2012-11-20 17:14:58 +01:00
value owner
2012-11-20 17:14:58 +01:00
When an option is modified, including at the instanciation, we
always know who has modified it. It's the owner of the option, see
:doc:`status` for more details.
2012-11-20 17:14:58 +01:00
.. glossary::
2012-11-20 17:14:58 +01:00
option with properties
2012-11-20 17:14:58 +01:00
an option wich has property like 'hidden' or 'disabled' is an option
wich has restricted acces rules
2012-11-20 17:14:58 +01:00
.. glossary::
2012-11-20 17:14:58 +01:00
hidden option
a hidden option has a different behaviour on regards to the access
of the value in the configuration, see :doc:`status` for more details.
.. glossary::
disabled option
a disabled option has a different behaviour on regards to the access
of the value in the configuration, see :doc:`status` for more details.
.. glossary::
mandatory option
A mandatory option is a configuration option wich value has to be
set, that is the default value cannot be `None`, see
`optionapi#optioninit`
.. glossary::
consistency
Preserve the consistency in a whole configuration is a tricky thing,
tiramisu takes care of it for you, see :doc:`consistency` for details.