stove/rougail
3
0
Fork 0
Code Issues 5 Pull requests 1 Projects Releases Wiki Activity

hidden property

Browse source
This commit is contained in:
gwen 2025-05-27 11:03:29 +02:00
parent e49f731aa2
commit dd0ae7d03b
2 changed files with 28 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/gettingstarted.rst
View file

@ -40,11 +40,16 @@ Then again:
What is a consistency handling system ?
------------------------------------------------
.. questions:: Question
.. questions:: Rougail, Tiramisu: What is all this stuff?
**Question**: OK, I have understood that the Rougail library enables me to take advantage of the :xref:`tiramisu` library. But what is all this for? What is exactly a consistency handling system? And again, what is this :xref:`tiramisu library` used for?
**Answer**: Well, now we explain what this :xref:`tiramisu` library is, and how we are using it.
**Answer**: Well, we will explain in details what this :xref:`tiramisu` library is and what Rougail is.
In (very) short:
- Rougail is the YAML consistency description of a configuration's situation
- Tiramisu is the consistency engine linter
.. glossary::

22
docs/tutorial/boolean.rst
View file

@ -148,8 +148,28 @@ And with this :confval:`use_for_https` boolean variable, there are two possibili
.. questions:: Question: disabled?
Is it relevant to use the :term:`disabled property <disabled>` here?
Is it relevant to use the :term:`disabled property <disabled>` here?
**answer**: No! Because we *need* to use these variables at any case,
we simply have to point their values ​​in one direction or another depending on this or that situation.
It is absolutely not a question of deactivating them. The :confval:`manual.https_proxy.address`
and the :confval:`manual.http_proxy.port` variables shall not be disabled (deactivated) in the manual mode.
Let's introduce here a new concept.
The hidden property
---------------------
.. glossary::
hidden
A variable or family's property is hidden if its value shall not be seen in a given consistency.
Anyway, these variables can be used again if the situation evolves. This is the main difference
between the `hidden` and the `disabled` properties.
..
How can we tell Rougail that this :confval:`use_for_https` boolean variable is used to enable/disable
the use of variables from the entire family?