No description

Find a file

Emmanuel Garette 38c804ecca [tutorial 030] A disabled family		2025-11-07 06:16:18 +01:00
config	[tutorial v1.1_030)] A disabled family (config and doc)	2025-11-07 06:16:18 +01:00
firefox	[tutorial 030] A disabled family	2025-11-07 06:16:18 +01:00
firefox.png	[tutorial v1.1_026)] A variable with type "boolean" (config and doc)	2025-11-07 06:16:16 +01:00
foxyproxy.png	[init] Discover Rougail	2025-11-07 06:16:04 +01:00
README.md	[tutorial v1.1_030)] A disabled family (config and doc)	2025-11-07 06:16:18 +01:00

README.md

[tutorial v1.1_030)] A disabled family

View the diff

Screenshot

Structure

firefox/00-proxy.yml

%YAML 1.2
---
version: 1.1

proxy_mode:
  description: Configure Proxy Access to the Internet
  choices:
    - No proxy
    - Auto-detect proxy settings for this network
    - Use system proxy settings
    - Manual proxy configuration
    - Automatic proxy configuration URL
  default: No proxy
...

firefox/10-manual.yml

%YAML 1.2
---
version: 1.1

manual:
  description: Manual proxy configuration
  disabled: true

  http_proxy:  # HTTP Proxy

    address:
      description: HTTP address
      type: domainname
      params:
        allow_ip: true

    port:
      description: HTTP Port
      type: port
      default: 8080
...

firefox/20-manual.yml

%YAML 1.2
---
version: 1.1

manual:

  use_for_https: true  # Also use this proxy for HTTPS

  https_proxy:  # HTTPS Proxy

    address:
      description: HTTPS address
      type: domainname
      params:
        allow_ip: true

    port:
      description: HTTPS Port
      type: port
      default: 8080
...

Let's generate the documentation

foo@bar:~$ git switch --detach v1.1_030
foo@bar:~$ rougail -m firefox/ -o doc

Variable	Description
proxy_mode `choice` `mandatory`	Configure Proxy Access to the Internet. Choices: - No proxy ← (default) - Auto-detect proxy settings for this network - Use system proxy settings - Manual proxy configuration - Automatic proxy configuration URL

Let's generate the changelog

foo@bar:~$ git switch --detach v1.1_030
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog

Deleted variables

manual.http_proxy.address
manual.http_proxy.port
manual.use_for_https
manual.https_proxy.address
manual.https_proxy.port

User datas

Example 1

config/01/config.yaml

---

Output

foo@bar:~$ git switch --detach v1.1_030
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml

╭─────── Caption ────────╮
│ Variable Default value │
╰────────────────────────╯
Variables:
┗━━ 📓 Configure Proxy Access to the Internet: No proxy

Output in read write mode

foo@bar:~$ git switch --detach v1.1_030
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml --cli.read_write

╭─────── Caption ────────╮
│ Variable Default value │
╰────────────────────────╯
Variables:
┗━━ 📓 Configure Proxy Access to the Internet: No proxy

Example 2

config/02/config.yaml

---
proxy_mode: Manual proxy configuration

Output

foo@bar:~$ git switch --detach v1.1_030
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml

╭────────────── Caption ───────────────╮
│ Variable Modified value              │
│          (⏳ Original default value) │
╰──────────────────────────────────────╯
Variables:
┗━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/02/config.yaml" (⏳ No proxy)

Output in read write mode

foo@bar:~$ git switch --detach v1.1_030
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml --cli.read_write

╭────────────── Caption ───────────────╮
│ Variable Modified value              │
│          (⏳ Original default value) │
╰──────────────────────────────────────╯
Variables:
┗━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/02/config.yaml" (⏳ No proxy)

Example 3

config/03/config.yaml

---
proxy_mode: Manual proxy configuration
manual:
  http_proxy:
    address: example.net

Output

foo@bar:~$ git switch --detach v1.1_030
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml

🔔 WARNINGS
┗━━ family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/03/config.yaml"
╭────────────── Caption ───────────────╮
│ Variable Modified value              │
│          (⏳ Original default value) │
╰──────────────────────────────────────╯
Variables:
┗━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" (⏳ No proxy)

Output in read write mode

foo@bar:~$ git switch --detach v1.1_030
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml --cli.read_write

🔔 WARNINGS
┗━━ family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/03/config.yaml"
╭────────────── Caption ───────────────╮
│ Variable Modified value              │
│          (⏳ Original default value) │
╰──────────────────────────────────────╯
Variables:
┗━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" (⏳ No proxy)

Example 4

config/04/config.yaml

---
proxy_mode: Manual proxy configuration
manual:
  http_proxy:
    address: example.net
    port: '3128'

Output

foo@bar:~$ git switch --detach v1.1_030
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml

🔔 WARNINGS
┣━━ family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/04/config.yaml"
┗━━ family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.port" (HTTP Port) will be ignored when loading from the YAML file "config/04/config.yaml"
╭────────────── Caption ───────────────╮
│ Variable Modified value              │
│          (⏳ Original default value) │
╰──────────────────────────────────────╯
Variables:
┗━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/04/config.yaml" (⏳ No proxy)

Output in read write mode

foo@bar:~$ git switch --detach v1.1_030
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml --cli.read_write

🔔 WARNINGS
┣━━ family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/04/config.yaml"
┗━━ family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.port" (HTTP Port) will be ignored when loading from the YAML file "config/04/config.yaml"
╭────────────── Caption ───────────────╮
│ Variable Modified value              │
│          (⏳ Original default value) │
╰──────────────────────────────────────╯
Variables:
┗━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/04/config.yaml" (⏳ No proxy)

Example 5

config/05/config.yaml

---
proxy_mode: Manual proxy configuration
manual:
  http_proxy:
    address: http.proxy.net
    port: '3128'
  use_for_https: false
  https_proxy:
    address: https.proxy.net

Output

foo@bar:~$ git switch --detach v1.1_030
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml

🔔 WARNINGS
┣━━ family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/05/config.yaml"
┣━━ family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.port" (HTTP Port) will be ignored when loading from the YAML file "config/05/config.yaml"
┣━━ family "manual" (Manual proxy configuration) is disabled, "manual.use_for_https" (Also use this proxy for HTTPS) will be ignored when loading from the YAML file "config/05/config.yaml"
┗━━ family "manual" (Manual proxy configuration) is disabled, "manual.https_proxy.address" (HTTPS address) will be ignored when loading from the YAML file "config/05/config.yaml"
╭────────────── Caption ───────────────╮
│ Variable Modified value              │
│          (⏳ Original default value) │
╰──────────────────────────────────────╯
Variables:
┗━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/05/config.yaml" (⏳ No proxy)

Output in read write mode

foo@bar:~$ git switch --detach v1.1_030
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml --cli.read_write

🔔 WARNINGS
┣━━ family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/05/config.yaml"
┣━━ family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.port" (HTTP Port) will be ignored when loading from the YAML file "config/05/config.yaml"
┣━━ family "manual" (Manual proxy configuration) is disabled, "manual.use_for_https" (Also use this proxy for HTTPS) will be ignored when loading from the YAML file "config/05/config.yaml"
┗━━ family "manual" (Manual proxy configuration) is disabled, "manual.https_proxy.address" (HTTPS address) will be ignored when loading from the YAML file "config/05/config.yaml"
╭────────────── Caption ───────────────╮
│ Variable Modified value              │
│          (⏳ Original default value) │
╰──────────────────────────────────────╯
Variables:
┗━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/05/config.yaml" (⏳ No proxy)

[tutorial v1.1_031] A conditional disabled family with a variable (diff)