From 9d0f0e9ae912d8eff15dff9ce21c33ee34fb3bc4 Mon Sep 17 00:00:00 2001 From: gwen Date: Tue, 20 Jan 2026 11:55:47 +0100 Subject: [PATCH] 15 ok --- docs/tutorial/disabled.rst | 53 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 51 insertions(+), 2 deletions(-) diff --git a/docs/tutorial/disabled.rst b/docs/tutorial/disabled.rst index fc5ff0b4d..9cbc731b9 100644 --- a/docs/tutorial/disabled.rst +++ b/docs/tutorial/disabled.rst @@ -511,7 +511,56 @@ We have this output: :url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_052/config/01/output_rw.html :class: output -FIXME +.. type-along:: The read only mode view and the read write mode view + +.. FIXME: Γ  unifier avec l'autre dΓ©finition de ro et rw dans la page dΓ©diΓ©e rougail/rw_ro_modes.html + +.. glossary:: + + read only mode + + We call this mode the `RO` mode. In this mode it is impossible to modify the values of the variables. + This is the standard configuration usage mode. + + read write mode + + We call this mode the `RW` mode. In this mode you can edit the variables, even these that have + been hidden or disabled. + +Why these modes ? In this way, the :term`operator` or the :term:`integrator` don't have to +add or pop familiy properties each time we pass from one use (editing mode) to another +(configuration using mode) to an other. Swithching modes with setting properties is not a good idea. +It's better to change the read write and the read_only mode inside a Rougail CLI session. + +.. note:: During a standard Rougail CLI session, the default usage is the read only mode. + We can switch at any time tho the read write mode by adding the `--cli.read_write` + Rougail CLI parameter. + +In the both `RO` and `RW` modes of the Rougail CLI session, we have this warning: + +:: + + πŸ”” Warning + ┗━━ manual (Manual proxy configuration) + ┗━━ https_proxy (HTTPS Proxy) + ┗━━ address (HTTPS address): πŸ”” family "https_proxy" (HTTPS Proxy) has + property hidden, so cannot access to "address" (HTTPS address), it + will be ignored when loading from the YAML file + "config/01/config.yml" + +We are warned that the `https_proxy` family has the `hidden` property. + +Note that this is only in the read only mode that the variables that lives in the `https_proxy` familiy are +set as **unmodifiable variable**: + +:: + + ┗━━ πŸ“‚ https_proxy (HTTPS Proxy) + ┣━━ πŸ““ address (HTTPS address): http.proxy.net + ┗━━ πŸ““ port (HTTPS Port): 3128 + +It is logical that we don't have this unmodifiable setting in the read write mode, +because the read/write mode is designed to be an editing mode. .. questions:: Question: shall we use the `disabled` property here? @@ -734,7 +783,7 @@ We are going to see how to point HTTPS variables to HTTP variables. - if the `proxy_mode` variable's value is not `'Manual proxy configuration'` the `manual` family is disabled - if the `proxy_mode` variable's value is `'Manual proxy configuration'` then the `manual` family is enabled - if the `use_for_https` variable's value is `true`, the HTTP configuration will be reused in the HTTPS situation - and the `https_proxy` familiy will be hidden + and the `https_proxy` family will be hidden - if the `manual.https_proxy.address` has no value set, the defaut value is the same as the `manual.http_proxy.address`'s value (same behavior with the HTTP port and the HTTPS port variable)