From 0cd0b7025c5207da020b0288ef7612343c3b0af1 Mon Sep 17 00:00:00 2001 From: Robin Schneider Date: Sat, 28 May 2016 22:30:15 +0200 Subject: [PATCH] Reference variables and hyperlink them with `any`. Related to https://github.com/debops/docs/pull/140. --- defaults/main.yml | 12 ++++++------ docs/defaults-configuration.rst | 8 ++++---- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/defaults/main.yml b/defaults/main.yml index d7d93da..9be76c6 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -30,7 +30,7 @@ ferm__enabled: '{{ True # .. envvar:: ferm__flush # # Should ferm-rules be flushed when :program:`ferm` is disabled? The default is true, -# but you may need set both ``ferm__enabled`` and this to ``False`` if you are +# but you may need set both :any:`ferm__enabled` and this to ``False`` if you are # running in some container and are not allowed to change :command:`iptables`. ferm__flush: '{{ ferm__enabled | bool }}' @@ -280,7 +280,7 @@ ferm__dependent_rules: [] # .. envvar:: ferm_input_list # -# List of iptables INPUT rules to manage. See :ref:`ferm_input_list` for more +# List of iptables INPUT rules to manage. See :ref:`ferm__ref_input_list` for more # details. This is a legacy variable and shouldn't be used. ferm_input_list: [] @@ -288,7 +288,7 @@ ferm_input_list: [] # .. envvar:: ferm_input_group_list # # List of iptables INPUT rules to manage for a host group. See -# :ref:`ferm_input_list` for more details. This is a legacy variable and +# :ref:`ferm__ref_input_list` for more details. This is a legacy variable and # shouldn't be used. ferm_input_group_list: [] @@ -296,7 +296,7 @@ ferm_input_group_list: [] # .. envvar:: ferm_input_host_list # # List of iptables INPUT rules to manage for an individual host. See -# :ref:`ferm_input_list` for more details. This is a legacy variable and +# :ref:`ferm__ref_input_list` for more details. This is a legacy variable and # shouldn't be used. ferm_input_host_list: [] @@ -304,7 +304,7 @@ ferm_input_host_list: [] # .. envvar:: ferm_input_dependent_list # # List of iptables INPUT rules to manage in dependency to other rules. See -# :ref:`ferm_input_list` for more details. This is a legacy variable and +# :ref:`ferm__ref_input_list` for more details. This is a legacy variable and # shouldn't be used. ferm_input_dependent_list: [] @@ -575,7 +575,7 @@ ferm__rules_filter_reject_all: # .. envvar:: ferm__rules_fail2ban # -# fail2ban support rules for ferm. +# ``fail2ban`` support rules for ferm. ferm__rules_fail2ban: - type: 'fail2ban' diff --git a/docs/defaults-configuration.rst b/docs/defaults-configuration.rst index 256425f..da6e7f7 100644 --- a/docs/defaults-configuration.rst +++ b/docs/defaults-configuration.rst @@ -9,7 +9,7 @@ them. :local: :depth: 1 -.. _ferm_input_list: +.. _ferm__ref_input_list: ferm_input_list --------------- @@ -20,8 +20,8 @@ instead in new configuration, the legacy variables will be removed at some point. List of ferm INPUT rules that should be present or absent in the firewall rule -set. The same format is also used for ``ferm_input_group_list``, -``ferm_input_host_list`` and ``ferm_input_dependent_list``. Each rule is +set. The same format is also used for :any:`ferm_input_group_list`, +:any:`ferm_input_host_list` and :any:`ferm_input_dependent_list`. Each rule is defined as a YAML dict with the following keys: ``type`` @@ -43,5 +43,5 @@ defined as a YAML dict with the following keys: Optional. Delete specified rule file. Possible values: ``False`` or ``True`` Depending on the chosen type, many additional variables are supported. Please -check the template files located in the ``templates/etc/ferm/filter-input.d/`` +check the template files located in the :file:`templates/etc/ferm/filter-input.d/` directory.