mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Fixed indentation. Comments and notes added.
This commit is contained in:
Vladimir Botka
parent
5b9d01ec2d
commit
0f38450868
4 changed files with 130 additions and 118 deletions
|
|
@ -5,6 +5,7 @@ list1:
|
||||||
extra: false
|
extra: false
|
||||||
- name: meh
|
- name: meh
|
||||||
extra: true
|
extra: true
|
||||||
|
|
||||||
list2:
|
list2:
|
||||||
- name: foo
|
- name: foo
|
||||||
path: /foo
|
path: /foo
|
||||||
|
|
|
||||||
|
|
@ -1,2 +1,2 @@
|
||||||
list3:
|
list3:
|
||||||
{{ list3|to_nice_yaml|indent(2) }}
|
{{ list3|to_nice_yaml(indent=0) }}
|
||||||
|
|
|
||||||
|
|
@ -1,15 +1,25 @@
|
||||||
---
|
---
|
||||||
|
|
||||||
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
||||||
# 1) Run all examples and create example-XXX.out
|
# 1) Run all examples and create example-XXX.out
|
||||||
# shell> ansible-playbook playbook.yml -e examples=true
|
# shell> ansible-playbook playbook.yml -e examples=true
|
||||||
#
|
#
|
||||||
# 2) Optionally, create examples_all.rst
|
# 2) Optionally, for testing, create examples_all.rst
|
||||||
# shell> ansible-playbook playbook.yml -e examples_all=true
|
# shell> ansible-playbook playbook.yml -e examples_all=true
|
||||||
#
|
#
|
||||||
# 3) Create other REST files. See the blocks below.
|
# 3) Create docs REST files
|
||||||
# shell> ansible-playbook playbook.yml -e merging_lists_of_dictionaries=true
|
# shell> ansible-playbook playbook.yml -e merging_lists_of_dictionaries=true
|
||||||
|
#
|
||||||
|
# Notes:
|
||||||
|
# * Use YAML callback, e.g. set ANSIBLE_STDOUT_CALLBACK=community.general.yaml
|
||||||
|
# * Use sphinx-view to render and review the REST files
|
||||||
|
# shell> sphinx-view <path_to_helper>/examples_all.rst
|
||||||
|
# * Proofread and copy completed docs *.rst files into the directory rst.
|
||||||
|
# * Then delete the *.rst and *.out files from this directory. Do not
|
||||||
|
# add *.rst and *.out in this directory to the version control.
|
||||||
|
#
|
||||||
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
||||||
# docs/docsite/helper/lists_mergeby/playbook.yml
|
# community.general/docs/docsite/helper/lists_mergeby/playbook.yml
|
||||||
|
|
||||||
- hosts: localhost
|
- hosts: localhost
|
||||||
gather_facts: false
|
gather_facts: false
|
||||||
|
|
|
||||||
|
|
@ -16,6 +16,7 @@ Let us use the lists below in the following examples
|
||||||
extra: false
|
extra: false
|
||||||
- name: meh
|
- name: meh
|
||||||
extra: true
|
extra: true
|
||||||
|
|
||||||
list2:
|
list2:
|
||||||
- name: foo
|
- name: foo
|
||||||
path: /foo
|
path: /foo
|
||||||
|
|
@ -34,15 +35,15 @@ This produces:
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
||||||
list3:
|
list3:
|
||||||
- extra: false
|
- extra: false
|
||||||
name: bar
|
name: bar
|
||||||
- name: baz
|
- name: baz
|
||||||
path: /baz
|
path: /baz
|
||||||
- extra: true
|
- extra: true
|
||||||
name: foo
|
name: foo
|
||||||
path: /foo
|
path: /foo
|
||||||
- extra: true
|
- extra: true
|
||||||
name: meh
|
name: meh
|
||||||
|
|
||||||
|
|
||||||
.. versionadded:: 2.0.0
|
.. versionadded:: 2.0.0
|
||||||
|
|
@ -59,15 +60,15 @@ This produces the same result as in the previous example:
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
||||||
list3:
|
list3:
|
||||||
- extra: false
|
- extra: false
|
||||||
name: bar
|
name: bar
|
||||||
- name: baz
|
- name: baz
|
||||||
path: /baz
|
path: /baz
|
||||||
- extra: true
|
- extra: true
|
||||||
name: foo
|
name: foo
|
||||||
path: /foo
|
path: /foo
|
||||||
- extra: true
|
- extra: true
|
||||||
name: meh
|
name: meh
|
||||||
|
|
||||||
|
|
||||||
The filter also accepts two optional parameters: ``recursive`` and ``list_merge``. These parameters are only supported when used with ansible-base 2.10 or ansible-core, but not with Ansible 2.9. This is available since community.general 4.4.0.
|
The filter also accepts two optional parameters: ``recursive`` and ``list_merge``. These parameters are only supported when used with ansible-base 2.10 or ansible-core, but not with Ansible 2.9. This is available since community.general 4.4.0.
|
||||||
|
|
@ -117,19 +118,19 @@ This produces:
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
||||||
list3:
|
list3:
|
||||||
- name: myname01
|
- name: myname01
|
||||||
param01:
|
param01:
|
||||||
list:
|
list:
|
||||||
- patch_value
|
- patch_value
|
||||||
x: default_value
|
x: default_value
|
||||||
y: patch_value
|
y: patch_value
|
||||||
z: patch_value
|
z: patch_value
|
||||||
- name: myname02
|
- name: myname02
|
||||||
param01:
|
param01:
|
||||||
- 3
|
- 3
|
||||||
- 4
|
- 4
|
||||||
- 4
|
- 4
|
||||||
- key: value
|
- key: value
|
||||||
|
|
||||||
Example ``list_merge=keep``:
|
Example ``list_merge=keep``:
|
||||||
|
|
||||||
|
|
@ -145,19 +146,19 @@ This produces:
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
||||||
list3:
|
list3:
|
||||||
- name: myname01
|
- name: myname01
|
||||||
param01:
|
param01:
|
||||||
list:
|
list:
|
||||||
- default_value
|
- default_value
|
||||||
x: default_value
|
x: default_value
|
||||||
y: patch_value
|
y: patch_value
|
||||||
z: patch_value
|
z: patch_value
|
||||||
- name: myname02
|
- name: myname02
|
||||||
param01:
|
param01:
|
||||||
- 1
|
- 1
|
||||||
- 1
|
- 1
|
||||||
- 2
|
- 2
|
||||||
- 3
|
- 3
|
||||||
|
|
||||||
Example ``list_merge=append``:
|
Example ``list_merge=append``:
|
||||||
|
|
||||||
|
|
@ -173,24 +174,24 @@ This produces:
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
||||||
list3:
|
list3:
|
||||||
- name: myname01
|
- name: myname01
|
||||||
param01:
|
param01:
|
||||||
list:
|
list:
|
||||||
- default_value
|
- default_value
|
||||||
- patch_value
|
- patch_value
|
||||||
x: default_value
|
x: default_value
|
||||||
y: patch_value
|
y: patch_value
|
||||||
z: patch_value
|
z: patch_value
|
||||||
- name: myname02
|
- name: myname02
|
||||||
param01:
|
param01:
|
||||||
- 1
|
- 1
|
||||||
- 1
|
- 1
|
||||||
- 2
|
- 2
|
||||||
- 3
|
- 3
|
||||||
- 3
|
- 3
|
||||||
- 4
|
- 4
|
||||||
- 4
|
- 4
|
||||||
- key: value
|
- key: value
|
||||||
|
|
||||||
Example ``list_merge=prepend``:
|
Example ``list_merge=prepend``:
|
||||||
|
|
||||||
|
|
@ -206,24 +207,24 @@ This produces:
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
||||||
list3:
|
list3:
|
||||||
- name: myname01
|
- name: myname01
|
||||||
param01:
|
param01:
|
||||||
list:
|
list:
|
||||||
- patch_value
|
- patch_value
|
||||||
- default_value
|
- default_value
|
||||||
x: default_value
|
x: default_value
|
||||||
y: patch_value
|
y: patch_value
|
||||||
z: patch_value
|
z: patch_value
|
||||||
- name: myname02
|
- name: myname02
|
||||||
param01:
|
param01:
|
||||||
- 3
|
- 3
|
||||||
- 4
|
- 4
|
||||||
- 4
|
- 4
|
||||||
- key: value
|
- key: value
|
||||||
- 1
|
- 1
|
||||||
- 1
|
- 1
|
||||||
- 2
|
- 2
|
||||||
- 3
|
- 3
|
||||||
|
|
||||||
Example ``list_merge=append_rp``:
|
Example ``list_merge=append_rp``:
|
||||||
|
|
||||||
|
|
@ -239,23 +240,23 @@ This produces:
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
||||||
list3:
|
list3:
|
||||||
- name: myname01
|
- name: myname01
|
||||||
param01:
|
param01:
|
||||||
list:
|
list:
|
||||||
- default_value
|
- default_value
|
||||||
- patch_value
|
- patch_value
|
||||||
x: default_value
|
x: default_value
|
||||||
y: patch_value
|
y: patch_value
|
||||||
z: patch_value
|
z: patch_value
|
||||||
- name: myname02
|
- name: myname02
|
||||||
param01:
|
param01:
|
||||||
- 1
|
- 1
|
||||||
- 1
|
- 1
|
||||||
- 2
|
- 2
|
||||||
- 3
|
- 3
|
||||||
- 4
|
- 4
|
||||||
- 4
|
- 4
|
||||||
- key: value
|
- key: value
|
||||||
|
|
||||||
Example ``list_merge=prepend_rp``:
|
Example ``list_merge=prepend_rp``:
|
||||||
|
|
||||||
|
|
@ -271,21 +272,21 @@ This produces:
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
||||||
list3:
|
list3:
|
||||||
- name: myname01
|
- name: myname01
|
||||||
param01:
|
param01:
|
||||||
list:
|
list:
|
||||||
- patch_value
|
- patch_value
|
||||||
- default_value
|
- default_value
|
||||||
x: default_value
|
x: default_value
|
||||||
y: patch_value
|
y: patch_value
|
||||||
z: patch_value
|
z: patch_value
|
||||||
- name: myname02
|
- name: myname02
|
||||||
param01:
|
param01:
|
||||||
- 3
|
- 3
|
||||||
- 4
|
- 4
|
||||||
- 4
|
- 4
|
||||||
- key: value
|
- key: value
|
||||||
- 1
|
- 1
|
||||||
- 1
|
- 1
|
||||||
- 2
|
- 2
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue