Skip to content

Commit 307140e

Browse files
authored
Remove parts from baseline that are included from ansible-core (and thus might change and make the tests fail). Add more formatting. (#51)
1 parent cde68eb commit 307140e

File tree

31 files changed

+107
-2181
lines changed

31 files changed

+107
-2181
lines changed

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,11 @@ Parameters
134134

135135
<div class="ansible-option-cell">
136136

137-
Bar.
137+
Bar. \ :strong:`BAR!`\
138+
139+
Totally unrelated to \ :emphasis:`become\_user`\ . Even with \ :emphasis:`become\_user=foo`\ .
140+
141+
Might not be compatible when \ :emphasis:`become\_user`\ is \ :literal:`bar`\ , though.
138142

139143

140144
.. raw:: html
@@ -266,7 +270,7 @@ Parameters
266270

267271
<div class="ansible-option-cell">
268272

269-
User you 'become' to execute the task
273+
User you 'become' to execute the task.
270274

271275

272276
.. rst-class:: ansible-option-line

tests/functional/baseline-default/collections/ns2/col/foo_connection.rst

Lines changed: 3 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@ ns2.col.foo connection -- Foo connection
5151

5252
.. version_added
5353
54+
.. rst-class:: ansible-version-added
55+
56+
New in ns2.col 1.2.0
5457

5558
.. contents::
5659
:local:
@@ -145,79 +148,6 @@ Parameters
145148
- Variable: delegated\_vars['ansible\_ssh\_host']
146149

147150

148-
.. raw:: html
149-
150-
</div>
151-
152-
* - .. raw:: html
153-
154-
<div class="ansible-option-cell">
155-
<div class="ansibleOptionAnchor" id="parameter-pipelining"></div>
156-
157-
.. _ansible_collections.ns2.col.foo_connection__parameter-pipelining:
158-
159-
.. rst-class:: ansible-option-title
160-
161-
**pipelining**
162-
163-
.. raw:: html
164-
165-
<a class="ansibleOptionLink" href="#parameter-pipelining" title="Permalink to this option"></a>
166-
167-
.. rst-class:: ansible-option-type-line
168-
169-
:ansible-option-type:`boolean`
170-
171-
172-
173-
174-
.. raw:: html
175-
176-
</div>
177-
178-
- .. raw:: html
179-
180-
<div class="ansible-option-cell">
181-
182-
Pipelining reduces the number of connection operations required to execute a module on the remote server, by executing many Ansible modules without actual file transfers.
183-
184-
This can result in a very significant performance improvement when enabled.
185-
186-
However this can conflict with privilege escalation (become). For example, when using sudo operations you must first disable 'requiretty' in the sudoers file for the target hosts, which is why this feature is disabled by default.
187-
188-
189-
.. rst-class:: ansible-option-line
190-
191-
:ansible-option-choices:`Choices:`
192-
193-
- :ansible-option-default-bold:`false` :ansible-option-default:`← (default)`
194-
- :ansible-option-choices-entry:`true`
195-
196-
197-
.. rst-class:: ansible-option-line
198-
199-
:ansible-option-configuration:`Configuration:`
200-
201-
- INI entries:
202-
203-
.. code-block::
204-
205-
[defaults]
206-
pipelining = false
207-
208-
209-
210-
.. code-block::
211-
212-
[connection]
213-
pipelining = false
214-
215-
216-
- Environment variable: ANSIBLE\_PIPELINING
217-
218-
- Variable: ansible\_pipelining
219-
220-
221151
.. raw:: html
222152

223153
</div>

tests/functional/baseline-default/collections/ns2/col/foo_module.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,8 @@ Parameters
142142

143143
A bar.
144144

145+
Independent from \ :emphasis:`foo`\ .
146+
145147

146148
.. raw:: html
147149

@@ -249,6 +251,8 @@ Parameters
249251

250252
Whatever.
251253

254+
Also required when \ :emphasis:`subfoo`\ is specified when \ :emphasis:`foo=bar`\ or \ :literal:`baz`\ .
255+
252256

253257
.. raw:: html
254258

0 commit comments

Comments
 (0)