Skip to content

Commit 6aaa181

Browse files
felixfonteinfelixfontein
committed
Update tests.
1 parent aea5933 commit 6aaa181

File tree

26 files changed

+247
-40
lines changed

26 files changed

+247
-40
lines changed

‎tests/functional/baseline-default/collections/environment_variables.rst‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
2+
:orphan:
3+
4+
.. _list_of_collection_env_vars:
5+
6+
Index of all Collection Environment Variables
7+
=============================================
8+
9+
The following index documents all environment variables declared by plugins and modules in collections.
10+
Environment variables used by the ansible-core configuation are documented in :ref:`ansible_configuration_settings`.
11+
12+
.. envvar:: ANSIBLE_FOO_EXE
13+
14+
Foo executable.
15+
16+
*Used by:*
17+
:ref:`ns2.col.foo become plugin <ansible_collections.ns2.col.foo_become>`
18+
.. envvar:: ANSIBLE_FOO_FILENAME_EXT
19+
20+
All extensions to check.
21+
22+
*Used by:*
23+
:ref:`ns2.col.foo vars plugin <ansible_collections.ns2.col.foo_vars>`
24+
.. envvar:: ANSIBLE_FOO_USER
25+
26+
User you 'become' to execute the task.
27+
28+
*Used by:*
29+
:ref:`ns2.col.foo become plugin <ansible_collections.ns2.col.foo_become>`
30+
.. envvar:: ANSIBLE_REMOTE_TEMP
31+
32+
Temporary directory to use on targets when executing tasks.
33+
34+
*Used by:*
35+
:ref:`ns2.col.foo shell plugin <ansible_collections.ns2.col.foo_shell>`
36+
.. envvar:: ANSIBLE_REMOTE_TMP
37+
38+
Temporary directory to use on targets when executing tasks.
39+
40+
*Used by:*
41+
:ref:`ns2.col.foo shell plugin <ansible_collections.ns2.col.foo_shell>`

‎tests/functional/baseline-default/collections/ns2/col/foo_become.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -211,9 +211,9 @@ Parameters
211211
Alternative: nothing
212212

213213

214-
- Environment variable: ANSIBLE\_BECOME\_EXE
214+
- Environment variable: :envvar:`ANSIBLE\_BECOME\_EXE`
215215

216-
- Environment variable: ANSIBLE\_FOO\_EXE
216+
- Environment variable: :envvar:`ANSIBLE\_FOO\_EXE`
217217

218218
Removed in: version 3.0.0
219219

@@ -297,11 +297,11 @@ Parameters
297297
user = root
298298
299299
300-
- Environment variable: ANSIBLE\_BECOME\_USER
300+
- Environment variable: :envvar:`ANSIBLE\_BECOME\_USER`
301301

302302
:ansible-option-versionadded:`added in ns2.col 0.1.0`
303303

304-
- Environment variable: ANSIBLE\_FOO\_USER
304+
- Environment variable: :envvar:`ANSIBLE\_FOO\_USER`
305305

306306
- Variable: ansible\_become\_user
307307

‎tests/functional/baseline-default/collections/ns2/col/foo_cache.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Parameters
141141
fact_caching_connection = VALUE
142142
143143
144-
- Environment variable: ANSIBLE\_CACHE\_PLUGIN\_CONNECTION
144+
- Environment variable: :envvar:`ANSIBLE\_CACHE\_PLUGIN\_CONNECTION`
145145

146146

147147
.. raw:: html

‎tests/functional/baseline-default/collections/ns2/col/foo_shell.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,9 +148,9 @@ Parameters
148148
remote_tmp = ~/.ansible/tmp
149149
150150
151-
- Environment variable: ANSIBLE\_REMOTE\_TEMP
151+
- Environment variable: :envvar:`ANSIBLE\_REMOTE\_TEMP`
152152

153-
- Environment variable: ANSIBLE\_REMOTE\_TMP
153+
- Environment variable: :envvar:`ANSIBLE\_REMOTE\_TMP`
154154

155155
- Variable: ansible\_remote\_tmp
156156

‎tests/functional/baseline-default/collections/ns2/col/foo_vars.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ Parameters
156156
foo_valid_extensions = .foo, .foobar
157157
158158
159-
- Environment variable: ANSIBLE\_FOO\_FILENAME\_EXT
159+
- Environment variable: :envvar:`ANSIBLE\_FOO\_FILENAME\_EXT`
160160

161161

162162
.. raw:: html

‎tests/functional/baseline-no-breadcrumbs/collections/environment_variables.rst‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
2+
:orphan:
3+
4+
.. _list_of_collection_env_vars:
5+
6+
Index of all Collection Environment Variables
7+
=============================================
8+
9+
The following index documents all environment variables declared by plugins and modules in collections.
10+
Environment variables used by the ansible-core configuation are documented in :ref:`ansible_configuration_settings`.
11+
12+
.. envvar:: ANSIBLE_FOO_EXE
13+
14+
Foo executable.
15+
16+
*Used by:*
17+
:ref:`ns2.col.foo become plugin <ansible_collections.ns2.col.foo_become>`
18+
.. envvar:: ANSIBLE_FOO_FILENAME_EXT
19+
20+
All extensions to check.
21+
22+
*Used by:*
23+
:ref:`ns2.col.foo vars plugin <ansible_collections.ns2.col.foo_vars>`
24+
.. envvar:: ANSIBLE_FOO_USER
25+
26+
User you 'become' to execute the task.
27+
28+
*Used by:*
29+
:ref:`ns2.col.foo become plugin <ansible_collections.ns2.col.foo_become>`
30+
.. envvar:: ANSIBLE_REMOTE_TEMP
31+
32+
Temporary directory to use on targets when executing tasks.
33+
34+
*Used by:*
35+
:ref:`ns2.col.foo shell plugin <ansible_collections.ns2.col.foo_shell>`
36+
.. envvar:: ANSIBLE_REMOTE_TMP
37+
38+
Temporary directory to use on targets when executing tasks.
39+
40+
*Used by:*
41+
:ref:`ns2.col.foo shell plugin <ansible_collections.ns2.col.foo_shell>`

‎tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_become.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -211,9 +211,9 @@ Parameters
211211
Alternative: nothing
212212

213213

214-
- Environment variable: ANSIBLE\_BECOME\_EXE
214+
- Environment variable: :envvar:`ANSIBLE\_BECOME\_EXE`
215215

216-
- Environment variable: ANSIBLE\_FOO\_EXE
216+
- Environment variable: :envvar:`ANSIBLE\_FOO\_EXE`
217217

218218
Removed in: version 3.0.0
219219

@@ -297,11 +297,11 @@ Parameters
297297
user = root
298298
299299
300-
- Environment variable: ANSIBLE\_BECOME\_USER
300+
- Environment variable: :envvar:`ANSIBLE\_BECOME\_USER`
301301

302302
:ansible-option-versionadded:`added in ns2.col 0.1.0`
303303

304-
- Environment variable: ANSIBLE\_FOO\_USER
304+
- Environment variable: :envvar:`ANSIBLE\_FOO\_USER`
305305

306306
- Variable: ansible\_become\_user
307307

‎tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_cache.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Parameters
141141
fact_caching_connection = VALUE
142142
143143
144-
- Environment variable: ANSIBLE\_CACHE\_PLUGIN\_CONNECTION
144+
- Environment variable: :envvar:`ANSIBLE\_CACHE\_PLUGIN\_CONNECTION`
145145

146146

147147
.. raw:: html

‎tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_shell.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,9 +148,9 @@ Parameters
148148
remote_tmp = ~/.ansible/tmp
149149
150150
151-
- Environment variable: ANSIBLE\_REMOTE\_TEMP
151+
- Environment variable: :envvar:`ANSIBLE\_REMOTE\_TEMP`
152152

153-
- Environment variable: ANSIBLE\_REMOTE\_TMP
153+
- Environment variable: :envvar:`ANSIBLE\_REMOTE\_TMP`
154154

155155
- Variable: ansible\_remote\_tmp
156156

‎tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_vars.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ Parameters
156156
foo_valid_extensions = .foo, .foobar
157157
158158
159-
- Environment variable: ANSIBLE\_FOO\_FILENAME\_EXT
159+
- Environment variable: :envvar:`ANSIBLE\_FOO\_FILENAME\_EXT`
160160

161161

162162
.. raw:: html

0 commit comments

Comments
 (0)