diff --git a/changelogs/fragments/403-arguments.yml b/changelogs/fragments/403-arguments.yml
new file mode 100644
index 00000000..31b0f397
--- /dev/null
+++ b/changelogs/fragments/403-arguments.yml
@@ -0,0 +1,5 @@
+bugfixes:
+ - "Fix bug that hid keyword config for plugin options for options that are only configurable this way (https://github.com/ansible-community/antsibull-docs/pull/403)."
+minor_changes:
+ - "For plugin options that can be configured through other means (Ansible variables, INI entries, environment variables, keywords, CLI arguments), show a notice on precedence below the plugin's parameters if more than one such way is present for an option
+ (https://github.com/ansible-community/antsibull-docs/pull/400, https://github.com/ansible-community/antsibull-docs/pull/403)."
diff --git a/src/antsibull_docs/data/docsite/ansible-docsite/macros/parameters.rst.j2 b/src/antsibull_docs/data/docsite/ansible-docsite/macros/parameters.rst.j2
index 6f33d409..7a91ee05 100644
--- a/src/antsibull_docs/data/docsite/ansible-docsite/macros/parameters.rst.j2
+++ b/src/antsibull_docs/data/docsite/ansible-docsite/macros/parameters.rst.j2
@@ -110,7 +110,7 @@
:ansible-option-default-bold:`Default:` :ansible-option-default:`@{ value['default'] | antsibull_to_json | rst_escape(escape_ending_whitespace=true) | rst_indent(6, blank=true) }@`
{% endif %}
{# Configuration #}
-{% if plugin_type != 'module' and plugin_type != 'role' and (value['ini'] or value['env'] or value['vars'] or value['cli']) %}
+{% if plugin_type != 'module' and plugin_type != 'role' and (value['ini'] or value['env'] or value['vars'] or value['keyword'] or value['cli']) %}
.. rst-class:: ansible-option-line
@@ -239,7 +239,7 @@
Default: @{ value['default'] | antsibull_to_json | escape | rst_indent(6, blank=true) }@
{% endif %}
{# Configuration #}
-{% if plugin_type != 'module' and plugin_type != 'role' and (value['ini'] or value['env'] or value['vars'] or value['cli']) %}
+{% if plugin_type != 'module' and plugin_type != 'role' and (value['ini'] or value['env'] or value['vars'] or value['keyword'] or value['cli']) %}
Configuration:
{% if value['ini'] %}
diff --git a/src/antsibull_docs/data/docsite/ansible-docsite/plugin.rst.j2 b/src/antsibull_docs/data/docsite/ansible-docsite/plugin.rst.j2
index fd95a4ac..4adcfca5 100644
--- a/src/antsibull_docs/data/docsite/ansible-docsite/plugin.rst.j2
+++ b/src/antsibull_docs/data/docsite/ansible-docsite/plugin.rst.j2
@@ -262,7 +262,7 @@ Parameters
@{ parameters_rst(doc['options'] | remove_options_from_list(options_to_skip) | dictsort, suboption_key='suboptions') }@
{% endif %}
{% endif %}
-{% if plugin_type != 'module' %}
+{% if plugin_type != 'module' and has_option_config_ambiguity %}
.. note::
diff --git a/src/antsibull_docs/data/docsite/simplified-rst/macros/parameters.rst.j2 b/src/antsibull_docs/data/docsite/simplified-rst/macros/parameters.rst.j2
index 094e3f35..651b8353 100644
--- a/src/antsibull_docs/data/docsite/simplified-rst/macros/parameters.rst.j2
+++ b/src/antsibull_docs/data/docsite/simplified-rst/macros/parameters.rst.j2
@@ -71,7 +71,7 @@
Default: @{ value['default'] | antsibull_to_json | escape | rst_indent(6, blank=true) }@
{% endif %}
{# Configuration #}
-{% if plugin_type != 'module' and plugin_type != 'role' and (value['ini'] or value['env'] or value['vars'] or value['cli']) %}
+{% if plugin_type != 'module' and plugin_type != 'role' and (value['ini'] or value['env'] or value['vars'] or value['keyword'] or value['cli']) %}
Configuration:
{% if value['ini'] %}
diff --git a/src/antsibull_docs/data/docsite/simplified-rst/plugin.rst.j2 b/src/antsibull_docs/data/docsite/simplified-rst/plugin.rst.j2
index 42a6b4cd..0c15481b 100644
--- a/src/antsibull_docs/data/docsite/simplified-rst/plugin.rst.j2
+++ b/src/antsibull_docs/data/docsite/simplified-rst/plugin.rst.j2
@@ -197,7 +197,7 @@ Parameters
@{ parameters_html(doc['options'] | remove_options_from_list(options_to_skip) | dictsort, suboption_key='suboptions') }@
{% endif %}
-{% if plugin_type != 'module' %}
+{% if plugin_type != 'module' and has_option_config_ambiguity %}
.. note::
diff --git a/src/antsibull_docs/write_docs/plugins.py b/src/antsibull_docs/write_docs/plugins.py
index 9950648e..b2aae8f1 100644
--- a/src/antsibull_docs/write_docs/plugins.py
+++ b/src/antsibull_docs/write_docs/plugins.py
@@ -120,6 +120,22 @@ def guess_relative_filename(
return f"{plugin_dir}/{plugin_short_name}.py"
+def has_option_config_ambiguity(documentation: dict[str, t.Any]) -> bool:
+ if not isinstance(documentation.get("options"), Mapping):
+ return False
+ for option in documentation["options"].values():
+ count = 0
+ for cfg in ("ini", "env", "vars", "keyword", "cli"):
+ if isinstance(option.get(cfg), Sequence):
+ count += len(option[cfg])
+ if count > 1:
+ return True
+ # TODO: We do not recurse into option["suboptions"] (if exists),
+ # since ansible-core's plugin manager does not handle these.
+ # If this ever changes, this code should be adjusted.
+ return False
+
+
def create_plugin_rst(
collection_name: str,
collection_meta: AnsibleCollectionMetadata,
@@ -253,6 +269,9 @@ def create_plugin_rst(
collection_communication=collection_links.communication,
collection_issue_tracker=collection_links.issue_tracker,
collection_deprecation_info=collection_meta.deprecation_info,
+ has_option_config_ambiguity=has_option_config_ambiguity(
+ plugin_record["doc"]
+ ),
for_official_docsite=for_official_docsite,
add_version=add_version,
)
diff --git a/tests/functional/ansible-doc-cache-all-others.json b/tests/functional/ansible-doc-cache-all-others.json
index c70361fb..7054ecb9 100644
--- a/tests/functional/ansible-doc-cache-all-others.json
+++ b/tests/functional/ansible-doc-cache-all-others.json
@@ -1405,6 +1405,11 @@
"options": {
"bar": {
"description": "Nothing.",
+ "env": [
+ {
+ "name": "FOO_BAR"
+ }
+ ],
"type": "string"
}
},
@@ -10508,7 +10513,12 @@
},
"bar": {
"description": "Foo bar.",
- "type": "string"
+ "type": "string",
+ "vars": [
+ {
+ "name": "foo_bar"
+ }
+ ]
}
},
"plugin_name": "ns2.col.foo",
diff --git a/tests/functional/ansible-doc-cache-all.json b/tests/functional/ansible-doc-cache-all.json
index 095cd905..958f48f0 100644
--- a/tests/functional/ansible-doc-cache-all.json
+++ b/tests/functional/ansible-doc-cache-all.json
@@ -1405,6 +1405,11 @@
"options": {
"bar": {
"description": "Nothing.",
+ "env": [
+ {
+ "name": "FOO_BAR"
+ }
+ ],
"type": "string"
}
},
@@ -10473,7 +10478,12 @@
},
"bar": {
"description": "Foo bar.",
- "type": "string"
+ "type": "string",
+ "vars": [
+ {
+ "name": "foo_bar"
+ }
+ ]
}
},
"plugin_name": "ns2.col.foo",
diff --git a/tests/functional/ansible-doc-cache-ansible.builtin-ns.col2-ns2.col.json b/tests/functional/ansible-doc-cache-ansible.builtin-ns.col2-ns2.col.json
index ee1d453f..a1cf6345 100644
--- a/tests/functional/ansible-doc-cache-ansible.builtin-ns.col2-ns2.col.json
+++ b/tests/functional/ansible-doc-cache-ansible.builtin-ns.col2-ns2.col.json
@@ -1405,6 +1405,11 @@
"options": {
"bar": {
"description": "Nothing.",
+ "env": [
+ {
+ "name": "FOO_BAR"
+ }
+ ],
"type": "string"
}
},
@@ -10473,7 +10478,12 @@
},
"bar": {
"description": "Foo bar.",
- "type": "string"
+ "type": "string",
+ "vars": [
+ {
+ "name": "foo_bar"
+ }
+ ]
}
},
"plugin_name": "ns2.col.foo",
diff --git a/tests/functional/ansible-doc-cache-ansible.builtin-ns2.col.json b/tests/functional/ansible-doc-cache-ansible.builtin-ns2.col.json
index c6cbd5b5..b4413d1e 100644
--- a/tests/functional/ansible-doc-cache-ansible.builtin-ns2.col.json
+++ b/tests/functional/ansible-doc-cache-ansible.builtin-ns2.col.json
@@ -1227,6 +1227,11 @@
"options": {
"bar": {
"description": "Nothing.",
+ "env": [
+ {
+ "name": "FOO_BAR"
+ }
+ ],
"type": "string"
}
},
@@ -10136,7 +10141,12 @@
},
"bar": {
"description": "Foo bar.",
- "type": "string"
+ "type": "string",
+ "vars": [
+ {
+ "name": "foo_bar"
+ }
+ ]
}
},
"plugin_name": "ns2.col.foo",
diff --git a/tests/functional/ansible-doc-cache-ns.col1-ns.col2-ns2.col-ns2.flatcol.json b/tests/functional/ansible-doc-cache-ns.col1-ns.col2-ns2.col-ns2.flatcol.json
index 27265bf6..eac071cc 100644
--- a/tests/functional/ansible-doc-cache-ns.col1-ns.col2-ns2.col-ns2.flatcol.json
+++ b/tests/functional/ansible-doc-cache-ns.col1-ns.col2-ns2.col-ns2.flatcol.json
@@ -376,6 +376,11 @@
"options": {
"bar": {
"description": "Nothing.",
+ "env": [
+ {
+ "name": "FOO_BAR"
+ }
+ ],
"type": "string"
}
},
@@ -1434,7 +1439,12 @@
},
"bar": {
"description": "Foo bar.",
- "type": "string"
+ "type": "string",
+ "vars": [
+ {
+ "name": "foo_bar"
+ }
+ ]
}
},
"plugin_name": "ns2.col.foo",
diff --git a/tests/functional/ansible-doc-cache-ns.col1-ns2.col-ns2.flatcol.json b/tests/functional/ansible-doc-cache-ns.col1-ns2.col-ns2.flatcol.json
index c11df462..72e9d96e 100644
--- a/tests/functional/ansible-doc-cache-ns.col1-ns2.col-ns2.flatcol.json
+++ b/tests/functional/ansible-doc-cache-ns.col1-ns2.col-ns2.flatcol.json
@@ -198,6 +198,11 @@
"options": {
"bar": {
"description": "Nothing.",
+ "env": [
+ {
+ "name": "FOO_BAR"
+ }
+ ],
"type": "string"
}
},
@@ -1097,7 +1102,12 @@
},
"bar": {
"description": "Foo bar.",
- "type": "string"
+ "type": "string",
+ "vars": [
+ {
+ "name": "foo_bar"
+ }
+ ]
}
},
"plugin_name": "ns2.col.foo",
diff --git a/tests/functional/ansible-doc-cache-ns2.col.json b/tests/functional/ansible-doc-cache-ns2.col.json
index 2e139955..5f41aba2 100644
--- a/tests/functional/ansible-doc-cache-ns2.col.json
+++ b/tests/functional/ansible-doc-cache-ns2.col.json
@@ -198,6 +198,11 @@
"options": {
"bar": {
"description": "Nothing.",
+ "env": [
+ {
+ "name": "FOO_BAR"
+ }
+ ],
"type": "string"
}
},
@@ -1097,7 +1102,12 @@
},
"bar": {
"description": "Foo bar.",
- "type": "string"
+ "type": "string",
+ "vars": [
+ {
+ "name": "foo_bar"
+ }
+ ]
}
},
"plugin_name": "ns2.col.foo",
diff --git a/tests/functional/baseline-default/collections/environment_variables.rst b/tests/functional/baseline-default/collections/environment_variables.rst
index 7625fb1c..ac01c26b 100644
--- a/tests/functional/baseline-default/collections/environment_variables.rst
+++ b/tests/functional/baseline-default/collections/environment_variables.rst
@@ -41,3 +41,9 @@ Environment variables used by the ansible-core configuration are documented in :
*Used by:*
:ansplugin:`ns2.col.foo shell plugin `
+.. envvar:: FOO_BAR
+
+ Nothing.
+
+ *Used by:*
+ :ansplugin:`ns2.col.foo callback plugin `
diff --git a/tests/functional/baseline-default/collections/ns2/col/bar_filter.rst b/tests/functional/baseline-default/collections/ns2/col/bar_filter.rst
index c244485c..959c448a 100644
--- a/tests/functional/baseline-default/collections/ns2/col/bar_filter.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/bar_filter.rst
@@ -300,13 +300,6 @@ example: ``input | ns2.col.bar(key1=value1, key2=value2, ...)``
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-default/collections/ns2/col/bar_test.rst b/tests/functional/baseline-default/collections/ns2/col/bar_test.rst
index 0192fc1a..03bafb04 100644
--- a/tests/functional/baseline-default/collections/ns2/col/bar_test.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/bar_test.rst
@@ -121,13 +121,6 @@ This describes the input of the test, the value before ``is ns2.col.bar`` or ``i
.. Options
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_callback.rst b/tests/functional/baseline-default/collections/ns2/col/foo_callback.rst
index 05def51c..1977add2 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_callback.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_callback.rst
@@ -118,17 +118,17 @@ Parameters
Nothing.
- .. raw:: html
+ .. rst-class:: ansible-option-line
-
+ :ansible-option-configuration:`Configuration:`
+ - Environment variable: :envvar:`FOO\_BAR`
-.. note::
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+ .. raw:: html
+
+
+
.. Attributes
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_cliconf.rst b/tests/functional/baseline-default/collections/ns2/col/foo_cliconf.rst
index 7d9bbe38..5c3e0f89 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_cliconf.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_cliconf.rst
@@ -63,13 +63,6 @@ Synopsis
.. Options
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_filter.rst b/tests/functional/baseline-default/collections/ns2/col/foo_filter.rst
index ae322a96..1071beb9 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_filter.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_filter.rst
@@ -214,13 +214,6 @@ example: ``input | ns2.col.foo(key1=value1, key2=value2, ...)``
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_inventory.rst b/tests/functional/baseline-default/collections/ns2/col/foo_inventory.rst
index baa4f2c5..a3936f5d 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_inventory.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_inventory.rst
@@ -117,13 +117,6 @@ Parameters
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_lookup.rst b/tests/functional/baseline-default/collections/ns2/col/foo_lookup.rst
index e592c621..23c06e59 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_lookup.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_lookup.rst
@@ -171,17 +171,17 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query('
Foo bar.
- .. raw:: html
+ .. rst-class:: ansible-option-line
-
+ :ansible-option-configuration:`Configuration:`
+ - Variable: foo\_bar
-.. note::
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+ .. raw:: html
+
+
+
.. Attributes
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_strategy.rst b/tests/functional/baseline-default/collections/ns2/col/foo_strategy.rst
index 969e515d..ab6c7792 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_strategy.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_strategy.rst
@@ -66,13 +66,6 @@ Synopsis
.. Options
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_test.rst b/tests/functional/baseline-default/collections/ns2/col/foo_test.rst
index e467d9f2..ebd9b4ae 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_test.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_test.rst
@@ -174,13 +174,6 @@ examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/environment_variables.rst b/tests/functional/baseline-no-breadcrumbs/collections/environment_variables.rst
index 7625fb1c..ac01c26b 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/environment_variables.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/environment_variables.rst
@@ -41,3 +41,9 @@ Environment variables used by the ansible-core configuration are documented in :
*Used by:*
:ansplugin:`ns2.col.foo shell plugin `
+.. envvar:: FOO_BAR
+
+ Nothing.
+
+ *Used by:*
+ :ansplugin:`ns2.col.foo callback plugin `
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/bar_filter.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/bar_filter.rst
index c244485c..959c448a 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/bar_filter.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/bar_filter.rst
@@ -300,13 +300,6 @@ example: ``input | ns2.col.bar(key1=value1, key2=value2, ...)``
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/bar_test.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/bar_test.rst
index 0192fc1a..03bafb04 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/bar_test.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/bar_test.rst
@@ -121,13 +121,6 @@ This describes the input of the test, the value before ``is ns2.col.bar`` or ``i
.. Options
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_callback.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_callback.rst
index 05def51c..1977add2 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_callback.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_callback.rst
@@ -118,17 +118,17 @@ Parameters
Nothing.
- .. raw:: html
+ .. rst-class:: ansible-option-line
-
+ :ansible-option-configuration:`Configuration:`
+ - Environment variable: :envvar:`FOO\_BAR`
-.. note::
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+ .. raw:: html
+
+
+
.. Attributes
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_cliconf.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_cliconf.rst
index 7d9bbe38..5c3e0f89 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_cliconf.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_cliconf.rst
@@ -63,13 +63,6 @@ Synopsis
.. Options
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_filter.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_filter.rst
index ae322a96..1071beb9 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_filter.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_filter.rst
@@ -214,13 +214,6 @@ example: ``input | ns2.col.foo(key1=value1, key2=value2, ...)``
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_inventory.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_inventory.rst
index baa4f2c5..a3936f5d 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_inventory.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_inventory.rst
@@ -117,13 +117,6 @@ Parameters
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_lookup.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_lookup.rst
index e592c621..23c06e59 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_lookup.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_lookup.rst
@@ -171,17 +171,17 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query('
Foo bar.
- .. raw:: html
+ .. rst-class:: ansible-option-line
-
+ :ansible-option-configuration:`Configuration:`
+ - Variable: foo\_bar
-.. note::
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+ .. raw:: html
+
+
+
.. Attributes
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_strategy.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_strategy.rst
index 969e515d..ab6c7792 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_strategy.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_strategy.rst
@@ -66,13 +66,6 @@ Synopsis
.. Options
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_test.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_test.rst
index e467d9f2..ebd9b4ae 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_test.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_test.rst
@@ -174,13 +174,6 @@ examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-no-indexes/collections/environment_variables.rst b/tests/functional/baseline-no-indexes/collections/environment_variables.rst
index f66cc85b..6c55fab9 100644
--- a/tests/functional/baseline-no-indexes/collections/environment_variables.rst
+++ b/tests/functional/baseline-no-indexes/collections/environment_variables.rst
@@ -38,3 +38,9 @@ Environment variables used by the ansible-core configuration are documented in :
*Used by:*
:ansplugin:`ns2.col.foo shell plugin `
+.. envvar:: FOO_BAR
+
+ Nothing.
+
+ *Used by:*
+ :ansplugin:`ns2.col.foo callback plugin `
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/bar_filter.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/bar_filter.rst
index ddb4963f..a271d82d 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/bar_filter.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/bar_filter.rst
@@ -297,13 +297,6 @@ example: ``input | ns2.col.bar(key1=value1, key2=value2, ...)``
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/bar_test.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/bar_test.rst
index 7db0de45..0cbb84cc 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/bar_test.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/bar_test.rst
@@ -118,13 +118,6 @@ This describes the input of the test, the value before ``is ns2.col.bar`` or ``i
.. Options
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_callback.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_callback.rst
index 8b93f785..946c1791 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_callback.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_callback.rst
@@ -115,17 +115,17 @@ Parameters
Nothing.
- .. raw:: html
+ .. rst-class:: ansible-option-line
-
+ :ansible-option-configuration:`Configuration:`
+ - Environment variable: :envvar:`FOO\_BAR`
-.. note::
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+ .. raw:: html
+
+
+
.. Attributes
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_cliconf.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_cliconf.rst
index 12122cd8..e986d3b2 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_cliconf.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_cliconf.rst
@@ -60,13 +60,6 @@ Synopsis
.. Options
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_filter.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_filter.rst
index 295847d6..08718853 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_filter.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_filter.rst
@@ -211,13 +211,6 @@ example: ``input | ns2.col.foo(key1=value1, key2=value2, ...)``
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_inventory.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_inventory.rst
index 7061f5b4..b54d9027 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_inventory.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_inventory.rst
@@ -114,13 +114,6 @@ Parameters
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_lookup.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_lookup.rst
index 05826d1f..c5eebd85 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_lookup.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_lookup.rst
@@ -168,17 +168,17 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query('
Foo bar.
- .. raw:: html
+ .. rst-class:: ansible-option-line
-
+ :ansible-option-configuration:`Configuration:`
+ - Variable: foo\_bar
-.. note::
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+ .. raw:: html
+
+
+
.. Attributes
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_strategy.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_strategy.rst
index 7f5e3080..9b971f6c 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_strategy.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_strategy.rst
@@ -63,13 +63,6 @@ Synopsis
.. Options
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_test.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_test.rst
index ad5a3599..740e8d19 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_test.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_test.rst
@@ -171,13 +171,6 @@ examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-plugin/ns2.col.foo_lookup.rst b/tests/functional/baseline-plugin/ns2.col.foo_lookup.rst
index 5aa8dfc0..87435bf8 100644
--- a/tests/functional/baseline-plugin/ns2.col.foo_lookup.rst
+++ b/tests/functional/baseline-plugin/ns2.col.foo_lookup.rst
@@ -170,17 +170,17 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query('
Foo bar.
- .. raw:: html
+ .. rst-class:: ansible-option-line
-
+ :ansible-option-configuration:`Configuration:`
+ - Variable: foo\_bar
-.. note::
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+ .. raw:: html
+
+
+
.. Attributes
diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/bar_filter.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/bar_filter.rst
index fbca5fa8..f8b294ca 100644
--- a/tests/functional/baseline-simplified-rst-squash-hierarchy/bar_filter.rst
+++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/bar_filter.rst
@@ -181,13 +181,6 @@ example: ``input | ns2.col.bar(key1=value1, key2=value2, ...)``
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
Notes
-----
diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/bar_test.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/bar_test.rst
index 62bd3b8e..e3037aa2 100644
--- a/tests/functional/baseline-simplified-rst-squash-hierarchy/bar_test.rst
+++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/bar_test.rst
@@ -67,13 +67,6 @@ This describes the input of the test, the value before ``is ns2.col.bar`` or ``i
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_callback.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_callback.rst
index b4e7d390..17347463 100644
--- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_callback.rst
+++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_callback.rst
@@ -61,6 +61,13 @@ Parameters
Nothing.
+ Configuration:
+
|
@@ -68,13 +75,6 @@ Parameters
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_cliconf.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_cliconf.rst
index 31631f98..9b4e6913 100644
--- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_cliconf.rst
+++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_cliconf.rst
@@ -31,13 +31,6 @@ Synopsis
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_filter.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_filter.rst
index a043d1c5..ad3931cc 100644
--- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_filter.rst
+++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_filter.rst
@@ -118,13 +118,6 @@ example: ``input | ns2.col.foo(key1=value1, key2=value2, ...)``
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_inventory.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_inventory.rst
index c87f95d4..b7770ace 100644
--- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_inventory.rst
+++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_inventory.rst
@@ -63,13 +63,6 @@ Parameters
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_lookup.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_lookup.rst
index 8614aa13..e4451261 100644
--- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_lookup.rst
+++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_lookup.rst
@@ -95,6 +95,13 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query('
Foo bar.
+ Configuration:
+
+ -
+
Variable: foo_bar
+
+
+
|
@@ -102,13 +109,6 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query('
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
Notes
-----
diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_strategy.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_strategy.rst
index f15c8020..5b15fa4b 100644
--- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_strategy.rst
+++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_strategy.rst
@@ -32,13 +32,6 @@ Synopsis
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_test.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_test.rst
index 59fd94a1..493e0b81 100644
--- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_test.rst
+++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_test.rst
@@ -101,13 +101,6 @@ examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/bar_filter.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/bar_filter.rst
index 707a540e..c4a63cfa 100644
--- a/tests/functional/baseline-simplified-rst/collections/ns2/col/bar_filter.rst
+++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/bar_filter.rst
@@ -181,13 +181,6 @@ example: ``input | ns2.col.bar(key1=value1, key2=value2, ...)``
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
Notes
-----
diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/bar_test.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/bar_test.rst
index a8bba1fa..1e77b48a 100644
--- a/tests/functional/baseline-simplified-rst/collections/ns2/col/bar_test.rst
+++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/bar_test.rst
@@ -67,13 +67,6 @@ This describes the input of the test, the value before ``is ns2.col.bar`` or ``i
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_callback.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_callback.rst
index 8231ca97..eb6f0cc8 100644
--- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_callback.rst
+++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_callback.rst
@@ -61,6 +61,13 @@ Parameters
Nothing.
+ Configuration:
+
|
@@ -68,13 +75,6 @@ Parameters
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_cliconf.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_cliconf.rst
index 24042bcf..fbd80892 100644
--- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_cliconf.rst
+++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_cliconf.rst
@@ -31,13 +31,6 @@ Synopsis
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_filter.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_filter.rst
index 7c866706..a20c97d5 100644
--- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_filter.rst
+++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_filter.rst
@@ -118,13 +118,6 @@ example: ``input | ns2.col.foo(key1=value1, key2=value2, ...)``
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_inventory.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_inventory.rst
index aac189ca..0dc0aace 100644
--- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_inventory.rst
+++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_inventory.rst
@@ -63,13 +63,6 @@ Parameters
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_lookup.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_lookup.rst
index 3428ab77..6a5215c7 100644
--- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_lookup.rst
+++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_lookup.rst
@@ -95,6 +95,13 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query('
Foo bar.
+ Configuration:
+
+ -
+
Variable: foo_bar
+
+
+
|
@@ -102,13 +109,6 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query('
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
Notes
-----
diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_strategy.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_strategy.rst
index 9b06cc5e..aa965c7b 100644
--- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_strategy.rst
+++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_strategy.rst
@@ -32,13 +32,6 @@ Synopsis
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_test.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_test.rst
index 176715b2..79fb69f4 100644
--- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_test.rst
+++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_test.rst
@@ -101,13 +101,6 @@ examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
diff --git a/tests/functional/baseline-squash-hierarchy/bar_filter.rst b/tests/functional/baseline-squash-hierarchy/bar_filter.rst
index c244485c..959c448a 100644
--- a/tests/functional/baseline-squash-hierarchy/bar_filter.rst
+++ b/tests/functional/baseline-squash-hierarchy/bar_filter.rst
@@ -300,13 +300,6 @@ example: ``input | ns2.col.bar(key1=value1, key2=value2, ...)``
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-squash-hierarchy/bar_test.rst b/tests/functional/baseline-squash-hierarchy/bar_test.rst
index 0192fc1a..03bafb04 100644
--- a/tests/functional/baseline-squash-hierarchy/bar_test.rst
+++ b/tests/functional/baseline-squash-hierarchy/bar_test.rst
@@ -121,13 +121,6 @@ This describes the input of the test, the value before ``is ns2.col.bar`` or ``i
.. Options
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-squash-hierarchy/environment_variables.rst b/tests/functional/baseline-squash-hierarchy/environment_variables.rst
index 7625fb1c..ac01c26b 100644
--- a/tests/functional/baseline-squash-hierarchy/environment_variables.rst
+++ b/tests/functional/baseline-squash-hierarchy/environment_variables.rst
@@ -41,3 +41,9 @@ Environment variables used by the ansible-core configuration are documented in :
*Used by:*
:ansplugin:`ns2.col.foo shell plugin `
+.. envvar:: FOO_BAR
+
+ Nothing.
+
+ *Used by:*
+ :ansplugin:`ns2.col.foo callback plugin `
diff --git a/tests/functional/baseline-squash-hierarchy/foo_callback.rst b/tests/functional/baseline-squash-hierarchy/foo_callback.rst
index 05def51c..1977add2 100644
--- a/tests/functional/baseline-squash-hierarchy/foo_callback.rst
+++ b/tests/functional/baseline-squash-hierarchy/foo_callback.rst
@@ -118,17 +118,17 @@ Parameters
Nothing.
- .. raw:: html
+ .. rst-class:: ansible-option-line
-
+ :ansible-option-configuration:`Configuration:`
+ - Environment variable: :envvar:`FOO\_BAR`
-.. note::
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+ .. raw:: html
+
+
+
.. Attributes
diff --git a/tests/functional/baseline-squash-hierarchy/foo_cliconf.rst b/tests/functional/baseline-squash-hierarchy/foo_cliconf.rst
index 7d9bbe38..5c3e0f89 100644
--- a/tests/functional/baseline-squash-hierarchy/foo_cliconf.rst
+++ b/tests/functional/baseline-squash-hierarchy/foo_cliconf.rst
@@ -63,13 +63,6 @@ Synopsis
.. Options
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-squash-hierarchy/foo_filter.rst b/tests/functional/baseline-squash-hierarchy/foo_filter.rst
index ae322a96..1071beb9 100644
--- a/tests/functional/baseline-squash-hierarchy/foo_filter.rst
+++ b/tests/functional/baseline-squash-hierarchy/foo_filter.rst
@@ -214,13 +214,6 @@ example: ``input | ns2.col.foo(key1=value1, key2=value2, ...)``
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-squash-hierarchy/foo_inventory.rst b/tests/functional/baseline-squash-hierarchy/foo_inventory.rst
index baa4f2c5..a3936f5d 100644
--- a/tests/functional/baseline-squash-hierarchy/foo_inventory.rst
+++ b/tests/functional/baseline-squash-hierarchy/foo_inventory.rst
@@ -117,13 +117,6 @@ Parameters
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-squash-hierarchy/foo_lookup.rst b/tests/functional/baseline-squash-hierarchy/foo_lookup.rst
index e592c621..23c06e59 100644
--- a/tests/functional/baseline-squash-hierarchy/foo_lookup.rst
+++ b/tests/functional/baseline-squash-hierarchy/foo_lookup.rst
@@ -171,17 +171,17 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query('
Foo bar.
- .. raw:: html
+ .. rst-class:: ansible-option-line
-
+ :ansible-option-configuration:`Configuration:`
+ - Variable: foo\_bar
-.. note::
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
+ .. raw:: html
+
+
+
.. Attributes
diff --git a/tests/functional/baseline-squash-hierarchy/foo_strategy.rst b/tests/functional/baseline-squash-hierarchy/foo_strategy.rst
index 969e515d..ab6c7792 100644
--- a/tests/functional/baseline-squash-hierarchy/foo_strategy.rst
+++ b/tests/functional/baseline-squash-hierarchy/foo_strategy.rst
@@ -66,13 +66,6 @@ Synopsis
.. Options
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-squash-hierarchy/foo_test.rst b/tests/functional/baseline-squash-hierarchy/foo_test.rst
index e467d9f2..ebd9b4ae 100644
--- a/tests/functional/baseline-squash-hierarchy/foo_test.rst
+++ b/tests/functional/baseline-squash-hierarchy/foo_test.rst
@@ -174,13 +174,6 @@ examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-use-html-blobs/collections/environment_variables.rst b/tests/functional/baseline-use-html-blobs/collections/environment_variables.rst
index 7625fb1c..ac01c26b 100644
--- a/tests/functional/baseline-use-html-blobs/collections/environment_variables.rst
+++ b/tests/functional/baseline-use-html-blobs/collections/environment_variables.rst
@@ -41,3 +41,9 @@ Environment variables used by the ansible-core configuration are documented in :
*Used by:*
:ansplugin:`ns2.col.foo shell plugin `
+.. envvar:: FOO_BAR
+
+ Nothing.
+
+ *Used by:*
+ :ansplugin:`ns2.col.foo callback plugin `
diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/bar_filter.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/bar_filter.rst
index 4a273356..645e1cf1 100644
--- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/bar_filter.rst
+++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/bar_filter.rst
@@ -219,13 +219,6 @@ example: ``input | ns2.col.bar(key1=value1, key2=value2, ...)``
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/bar_test.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/bar_test.rst
index f6b42552..1667a9ab 100644
--- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/bar_test.rst
+++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/bar_test.rst
@@ -101,13 +101,6 @@ This describes the input of the test, the value before ``is ns2.col.bar`` or ``i
.. Options
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_callback.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_callback.rst
index 2dc98a10..eb137d88 100644
--- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_callback.rst
+++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_callback.rst
@@ -96,6 +96,13 @@ Parameters
Nothing.
+ Configuration:
+
|
@@ -103,13 +110,6 @@ Parameters
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_cliconf.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_cliconf.rst
index 7d9bbe38..5c3e0f89 100644
--- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_cliconf.rst
+++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_cliconf.rst
@@ -63,13 +63,6 @@ Synopsis
.. Options
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_filter.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_filter.rst
index 816156c1..3a27e7c3 100644
--- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_filter.rst
+++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_filter.rst
@@ -154,13 +154,6 @@ example: ``input | ns2.col.foo(key1=value1, key2=value2, ...)``
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_inventory.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_inventory.rst
index 49361742..29a18418 100644
--- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_inventory.rst
+++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_inventory.rst
@@ -97,13 +97,6 @@ Parameters
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_lookup.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_lookup.rst
index f70005ff..ee2a2162 100644
--- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_lookup.rst
+++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_lookup.rst
@@ -131,6 +131,13 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query('
Foo bar.
+ Configuration:
+
+ -
+
Variable: foo_bar
+
+
+
|
@@ -138,13 +145,6 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query('
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_strategy.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_strategy.rst
index 969e515d..ab6c7792 100644
--- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_strategy.rst
+++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_strategy.rst
@@ -66,13 +66,6 @@ Synopsis
.. Options
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_test.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_test.rst
index 66123e36..49bc2ac6 100644
--- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_test.rst
+++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_test.rst
@@ -135,13 +135,6 @@ examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is
-.. note::
-
- Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order.
- For example, a variable that is lower in the list will override a variable that is higher up.
- The entry types are also ordered by precedence from low to high priority order.
- For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
-
.. Attributes
diff --git a/tests/functional/collections/ansible_collections/ns2/col/plugins/callback/foo.py b/tests/functional/collections/ansible_collections/ns2/col/plugins/callback/foo.py
index 464ccd8b..fd0f014d 100644
--- a/tests/functional/collections/ansible_collections/ns2/col/plugins/callback/foo.py
+++ b/tests/functional/collections/ansible_collections/ns2/col/plugins/callback/foo.py
@@ -17,6 +17,8 @@
bar:
description: Nothing.
type: string
+ env:
+ - name: FOO_BAR
"""
from ansible.plugins.callback import CallbackBase
diff --git a/tests/functional/collections/ansible_collections/ns2/col/plugins/lookup/foo.py b/tests/functional/collections/ansible_collections/ns2/col/plugins/lookup/foo.py
index dcee7628..a0a18222 100644
--- a/tests/functional/collections/ansible_collections/ns2/col/plugins/lookup/foo.py
+++ b/tests/functional/collections/ansible_collections/ns2/col/plugins/lookup/foo.py
@@ -23,6 +23,8 @@
bar:
description: Foo bar.
type: string
+ vars:
+ - name: foo_bar
"""
EXAMPLES = """