Infra
/
tiramisu
5
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

doc : new git repository

This commit is contained in:
gwen 2018-08-14 12:03:47 +02:00
parent caaeb93333
commit 071e9c20d4
1 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/getting-started.txt
View File

@ -5,10 +5,10 @@ Getting started
What is options handling ? What is options handling ?
================================= =================================
Due to more and more available options required to set up an operating system, Due to more and more available options required to set up an operating system,
compiler options or whatever, it became quite annoying to hand the necessary compiler options or whatever, it became quite annoying to hand the necessary
options to where they are actually used and even more annoying to add new options to where they are actually used and even more annoying to add new
options. To circumvent these problems the configuration control was options. To circumvent these problems the configuration control was
introduced... introduced...
What is Tiramisu ? What is Tiramisu ?
@ -18,7 +18,7 @@ Tiramisu is an options handler and an options controller, which aims at
producing flexible and fast options access. The main advantages are its access producing flexible and fast options access. The main advantages are its access
rules and the fact that the whole consistency is preserved at any time, see rules and the fact that the whole consistency is preserved at any time, see
:doc:`consistency`. There is of course type and structure validations, but also :doc:`consistency`. There is of course type and structure validations, but also
validations towards the whole options. Furthermore, options can be reached and validations towards the whole options. Furthermore, options can be reached and
changed according to the access rules from nearly everywhere in your appliance. changed according to the access rules from nearly everywhere in your appliance.
Just the facts Just the facts
@ -26,15 +26,20 @@ Just the facts
.. _gettingtiramisu: .. _gettingtiramisu:
`tiramisu`\ 's home page is here_
.. _here: https://forge.cadoles.com/Cadoles/tiramisu
Download Download
--------- ---------
To obtain a copy of the sources, check it out from the repository using `git`. To obtain a copy of the sources, check it out from the repository using `git`.
We suggest using `git` if one wants to access to the current developments. We suggest using `git` if one wants to access to the current developments.
:: ::
git clone git://git.labs.libre-entreprise.org/tiramisu.git git clone https://forge.cadoles.com/Cadoles/tiramisu.git
This will get you a fresh checkout of the code repository in a local directory This will get you a fresh checkout of the code repository in a local directory
named ``tiramisu``. named ``tiramisu``.
@ -65,17 +70,17 @@ So by now, we have:
- a namespace (which is `c` here) - a namespace (which is `c` here)
- the access of an option's value by the - the access of an option's value by the
attribute access way (here `bool`, which is a boolean option attribute access way (here `bool`, which is a boolean option
:class:`~tiramisu.option.BoolOption()`. :class:`~tiramisu.option.BoolOption()`.
So, option objects are produced at the entry point `c` and then handed down to So, option objects are produced at the entry point `c` and then handed down to
where they are actually used when `c.bool` is triggered. This keeps options where they are actually used when `c.bool` is triggered. This keeps options
local but available at any timer and consistent. local but available at any timer and consistent.
Once the namespace is created, we can set a Once the namespace is created, we can set a
:meth:`~config.CommonConfig.read_write()` access to the options:: :meth:`~config.CommonConfig.read_write()` access to the options::
>>> c.read_write() >>> c.read_write()
which enables us to set a bunch of access rules that we wil explain later in which enables us to set a bunch of access rules that we wil explain later in
:doc:`status`. :doc:`status`.