rougail-tutorials/README.md

• Summary
• [tutorial v1.1_024] Copy HTTP manual proxy to HTTPS manual proxy (diff)

[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

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