From aadf0f1a064f1f0030336de93e4cfdfa9c499aea Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Sat, 2 Nov 2024 14:58:19 +0100 Subject: [PATCH] [tutorial 023] Family type is optional (config and doc) --- README.md | 148 ++++++--------------------------------- config/01/output_rw.html | 4 -- config/02/config.yaml | 2 +- config/02/output_rw.html | 4 -- config/03/config.yaml | 3 - config/03/output_ro.html | 13 +--- config/03/output_rw.html | 11 --- config/04/config.yaml | 6 +- config/04/output_ro.html | 16 ++--- config/04/output_rw.html | 11 --- config/05/config.yaml | 9 +-- config/05/output_ro.html | 18 ++--- config/05/output_rw.html | 11 --- 13 files changed, 36 insertions(+), 220 deletions(-) delete mode 100644 config/01/output_rw.html delete mode 100644 config/02/output_rw.html delete mode 100644 config/03/output_rw.html delete mode 100644 config/04/output_rw.html delete mode 100644 config/05/output_rw.html diff --git a/README.md b/README.md index e2f0108..18ecd18 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[tutorial 021] A sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_021/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_021~1..v1.1_021)) +- [[tutorial 022] A variable inside sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022)) -# [tutorial 022] A variable inside sub family +# [tutorial 023] Family type is optional -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_023~1..v1.1_023) ## Screenshot @@ -38,11 +38,9 @@ proxy_mode: --- manual: description: Manual proxy configuration - type: family http_proxy: description: HTTP Proxy - type: family address: description: HTTP address @@ -88,16 +86,6 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml ┣━━ The following variables are mandatory but have no value: ┗━━ - manual.http_proxy.address (HTTP address) -#### Output in read write mode - -```console -foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml --exporter.read_write -``` -
🛑 ERRORS
-┣━━ The following variables are mandatory but have no value:
-┗━━   - manual.http_proxy.address (HTTP address)
-

-
### Example 2 #### config/02/config.yaml @@ -105,7 +93,7 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml --export ```yml --- -proxy_mode: Manual proxy configuration +proxy_mode: No proxy ``` #### Output @@ -117,16 +105,6 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml ┣━━ The following variables are mandatory but have no value: ┗━━ - manual.http_proxy.address (HTTP address) -#### Output in read write mode - -```console -foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml --exporter.read_write -``` -
🛑 ERRORS
-┣━━ The following variables are mandatory but have no value:
-┗━━   - manual.http_proxy.address (HTTP address)
-

-
### Example 3 #### config/03/config.yaml @@ -135,9 +113,6 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml --export ```yml --- proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: example.net ``` #### Output @@ -145,33 +120,9 @@ manual: ```console foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml ``` -
╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-┗━━ 📂 manual
-    ┗━━ 📂 http_proxy
-        ┗━━ 📓 address: example.net
-
-#### Output in read write mode - -```console -foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml --exporter.read_write -``` -
╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-┗━━ 📂 manual
-    ┗━━ 📂 http_proxy
-        ┗━━ 📓 address: example.net
-

+
🛑 ERRORS
+┣━━ The following variables are mandatory but have no value:
+┗━━   - manual.http_proxy.address (HTTP address)
 

 ### Example 4
 
@@ -180,11 +131,7 @@ Variables:
 
 ```yml
 ---
-proxy_mode: Manual proxy configuration
-manual:
-  http_proxy:
-    address: example.net
-    port: '3128'
+proxy_mode: foo
 
 ```
 #### Output
@@ -193,34 +140,11 @@ manual:
 foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml
 ```
 
🛑 ERRORS
-┗━━ unknown option "port" in optiondescription "manual.http_proxy" (HTTP Proxy)
-╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-┗━━ 📂 manual
-    ┗━━ 📂 http_proxy
-        ┗━━ 📓 address: example.net
-

-#### Output in read write mode
-
-```console
-foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml --exporter.read_write
-```
-
╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-┗━━ 📂 manual
-    ┗━━ 📂 http_proxy
-        ┗━━ 📓 address: example.net
-

+┣━━ "foo" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only 
+┃   "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy 
+┃   configuration", "No proxy" and "Use system proxy settings" are allowed
+┣━━ The following variables are mandatory but have no value:
+┗━━   - manual.http_proxy.address (HTTP address)
 

 ### Example 5
 
@@ -229,14 +153,7 @@ Variables:
 
 ```yml
 ---
-proxy_mode: Manual proxy configuration
-manual:
-  http_proxy:
-    address: http.proxy.net
-    port: '3128'
-  use_for_https: false
-  https_proxy:
-    address: https.proxy.net
+proxy_mode: 1
 
 ```
 #### Output
@@ -245,37 +162,12 @@ manual:
 foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml
 ```
 
🛑 ERRORS
-┣━━ unknown option "port" in optiondescription "manual.http_proxy" (HTTP Proxy)
-┣━━ unknown option "use_for_https" in optiondescription "manual" (Manual proxy configuration)
-┗━━ unknown option "https_proxy" in optiondescription "manual" (Manual proxy configuration)
-╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-┗━━ 📂 manual
-    ┗━━ 📂 http_proxy
-        ┗━━ 📓 address: http.proxy.net
-

-#### Output in read write mode
-
-```console
-foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml --exporter.read_write
-```
-
╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-┗━━ 📂 manual
-    ┗━━ 📂 http_proxy
-        ┗━━ 📓 address: http.proxy.net
-

+┣━━ "1" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only "Auto-detect
+┃   proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy configuration", 
+┃   "No proxy" and "Use system proxy settings" are allowed
+┣━━ The following variables are mandatory but have no value:
+┗━━   - manual.http_proxy.address (HTTP address)
 

 
 
-- [[tutorial 023] Family type is optional](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_023/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_023~1..v1.1_023))
+- [[tutorial 024] A variable with type "domainname"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_024/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_024~1..v1.1_024))
diff --git a/config/01/output_rw.html b/config/01/output_rw.html
deleted file mode 100644
index 28450ac..0000000
--- a/config/01/output_rw.html
+++ /dev/null
@@ -1,4 +0,0 @@
-
🛑 ERRORS
-┣━━ The following variables are mandatory but have no value:
-┗━━   - manual.http_proxy.address (HTTP address)
-

diff --git a/config/02/config.yaml b/config/02/config.yaml
index 74edb22..d914488 100644
--- a/config/02/config.yaml
+++ b/config/02/config.yaml
@@ -1,2 +1,2 @@
 ---
-proxy_mode: Manual proxy configuration
+proxy_mode: No proxy
diff --git a/config/02/output_rw.html b/config/02/output_rw.html
deleted file mode 100644
index 28450ac..0000000
--- a/config/02/output_rw.html
+++ /dev/null
@@ -1,4 +0,0 @@
-
🛑 ERRORS
-┣━━ The following variables are mandatory but have no value:
-┗━━   - manual.http_proxy.address (HTTP address)
-

diff --git a/config/03/config.yaml b/config/03/config.yaml
index e3db924..74edb22 100644
--- a/config/03/config.yaml
+++ b/config/03/config.yaml
@@ -1,5 +1,2 @@
 ---
 proxy_mode: Manual proxy configuration
-manual:
-  http_proxy:
-    address: example.net
diff --git a/config/03/output_ro.html b/config/03/output_ro.html
index 9ea732e..28450ac 100644
--- a/config/03/output_ro.html
+++ b/config/03/output_ro.html
@@ -1,11 +1,4 @@
-
╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-┗━━ 📂 manual
-    ┗━━ 📂 http_proxy
-        ┗━━ 📓 address: example.net
+
🛑 ERRORS
+┣━━ The following variables are mandatory but have no value:
+┗━━   - manual.http_proxy.address (HTTP address)
 

diff --git a/config/03/output_rw.html b/config/03/output_rw.html
deleted file mode 100644
index 9ea732e..0000000
--- a/config/03/output_rw.html
+++ /dev/null
@@ -1,11 +0,0 @@
-
╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-┗━━ 📂 manual
-    ┗━━ 📂 http_proxy
-        ┗━━ 📓 address: example.net
-

diff --git a/config/04/config.yaml b/config/04/config.yaml
index c8d73af..e3fa25d 100644
--- a/config/04/config.yaml
+++ b/config/04/config.yaml
@@ -1,6 +1,2 @@
 ---
-proxy_mode: Manual proxy configuration
-manual:
-  http_proxy:
-    address: example.net
-    port: '3128'
+proxy_mode: foo
diff --git a/config/04/output_ro.html b/config/04/output_ro.html
index b07fec9..082c874 100644
--- a/config/04/output_ro.html
+++ b/config/04/output_ro.html
@@ -1,13 +1,7 @@
 
🛑 ERRORS
-┗━━ unknown option "port" in optiondescription "manual.http_proxy" (HTTP Proxy)
-╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-┗━━ 📂 manual
-    ┗━━ 📂 http_proxy
-        ┗━━ 📓 address: example.net
+┣━━ "foo" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only 
+┃   "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy 
+┃   configuration", "No proxy" and "Use system proxy settings" are allowed
+┣━━ The following variables are mandatory but have no value:
+┗━━   - manual.http_proxy.address (HTTP address)
 

diff --git a/config/04/output_rw.html b/config/04/output_rw.html
deleted file mode 100644
index 9ea732e..0000000
--- a/config/04/output_rw.html
+++ /dev/null
@@ -1,11 +0,0 @@
-
╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-┗━━ 📂 manual
-    ┗━━ 📂 http_proxy
-        ┗━━ 📓 address: example.net
-

diff --git a/config/05/config.yaml b/config/05/config.yaml
index 4a1f789..bf6f64c 100644
--- a/config/05/config.yaml
+++ b/config/05/config.yaml
@@ -1,9 +1,2 @@
 ---
-proxy_mode: Manual proxy configuration
-manual:
-  http_proxy:
-    address: http.proxy.net
-    port: '3128'
-  use_for_https: false
-  https_proxy:
-    address: https.proxy.net
+proxy_mode: 1
diff --git a/config/05/output_ro.html b/config/05/output_ro.html
index 4f8e0ee..3c3b276 100644
--- a/config/05/output_ro.html
+++ b/config/05/output_ro.html
@@ -1,15 +1,7 @@
 
🛑 ERRORS
-┣━━ unknown option "port" in optiondescription "manual.http_proxy" (HTTP Proxy)
-┣━━ unknown option "use_for_https" in optiondescription "manual" (Manual proxy configuration)
-┗━━ unknown option "https_proxy" in optiondescription "manual" (Manual proxy configuration)
-╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-┗━━ 📂 manual
-    ┗━━ 📂 http_proxy
-        ┗━━ 📓 address: http.proxy.net
+┣━━ "1" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only "Auto-detect
+┃   proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy configuration", 
+┃   "No proxy" and "Use system proxy settings" are allowed
+┣━━ The following variables are mandatory but have no value:
+┗━━   - manual.http_proxy.address (HTTP address)
 

diff --git a/config/05/output_rw.html b/config/05/output_rw.html
deleted file mode 100644
index f810fdc..0000000
--- a/config/05/output_rw.html
+++ /dev/null
@@ -1,11 +0,0 @@
-
╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
-┗━━ 📂 manual
-    ┗━━ 📂 http_proxy
-        ┗━━ 📓 address: http.proxy.net
-