From 951570316b50c5f1e16bb6ea0b1adc15e57997fe Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Fri, 25 Sep 2020 22:22:29 +0200 Subject: [PATCH] Standardize on name and type (for callbacks). --- lib/ansible/plugins/become/runas.py | 2 +- lib/ansible/plugins/become/su.py | 2 +- lib/ansible/plugins/become/sudo.py | 2 +- lib/ansible/plugins/cache/jsonfile.py | 2 +- lib/ansible/plugins/cache/memory.py | 2 +- lib/ansible/plugins/callback/default.py | 2 +- lib/ansible/plugins/callback/junit.py | 2 +- lib/ansible/plugins/callback/minimal.py | 2 +- lib/ansible/plugins/callback/oneline.py | 2 +- lib/ansible/plugins/callback/tree.py | 4 ++-- lib/ansible/plugins/connection/local.py | 2 +- lib/ansible/plugins/connection/paramiko_ssh.py | 2 +- lib/ansible/plugins/connection/psrp.py | 2 +- lib/ansible/plugins/connection/ssh.py | 2 +- lib/ansible/plugins/connection/winrm.py | 2 +- lib/ansible/plugins/inventory/advanced_host_list.py | 2 +- lib/ansible/plugins/inventory/auto.py | 1 - lib/ansible/plugins/inventory/constructed.py | 1 - lib/ansible/plugins/inventory/generator.py | 1 - lib/ansible/plugins/inventory/host_list.py | 2 +- lib/ansible/plugins/inventory/ini.py | 2 +- lib/ansible/plugins/inventory/script.py | 2 +- lib/ansible/plugins/inventory/toml.py | 2 +- lib/ansible/plugins/inventory/yaml.py | 2 +- lib/ansible/plugins/lookup/config.py | 2 +- lib/ansible/plugins/lookup/csvfile.py | 2 +- lib/ansible/plugins/lookup/dict.py | 2 +- lib/ansible/plugins/lookup/env.py | 2 +- lib/ansible/plugins/lookup/file.py | 2 +- lib/ansible/plugins/lookup/fileglob.py | 2 +- lib/ansible/plugins/lookup/first_found.py | 2 +- lib/ansible/plugins/lookup/indexed_items.py | 2 +- lib/ansible/plugins/lookup/ini.py | 2 +- lib/ansible/plugins/lookup/inventory_hostnames.py | 2 +- lib/ansible/plugins/lookup/items.py | 2 +- lib/ansible/plugins/lookup/lines.py | 2 +- lib/ansible/plugins/lookup/list.py | 2 +- lib/ansible/plugins/lookup/nested.py | 2 +- lib/ansible/plugins/lookup/password.py | 2 +- lib/ansible/plugins/lookup/pipe.py | 2 +- lib/ansible/plugins/lookup/random_choice.py | 2 +- lib/ansible/plugins/lookup/sequence.py | 2 +- lib/ansible/plugins/lookup/subelements.py | 2 +- lib/ansible/plugins/lookup/template.py | 2 +- lib/ansible/plugins/lookup/together.py | 2 +- lib/ansible/plugins/lookup/unvault.py | 2 +- lib/ansible/plugins/lookup/url.py | 2 +- lib/ansible/plugins/lookup/varnames.py | 2 +- lib/ansible/plugins/lookup/vars.py | 2 +- lib/ansible/plugins/shell/cmd.py | 1 - lib/ansible/plugins/shell/powershell.py | 1 - lib/ansible/plugins/shell/sh.py | 1 - lib/ansible/plugins/strategy/debug.py | 2 +- lib/ansible/plugins/strategy/free.py | 2 +- lib/ansible/plugins/strategy/host_pinned.py | 2 +- lib/ansible/plugins/strategy/linear.py | 2 +- lib/ansible/plugins/vars/host_group_vars.py | 2 +- 57 files changed, 52 insertions(+), 58 deletions(-) diff --git a/lib/ansible/plugins/become/runas.py b/lib/ansible/plugins/become/runas.py index c8ae881c3c2..1d6e8f9f947 100644 --- a/lib/ansible/plugins/become/runas.py +++ b/lib/ansible/plugins/become/runas.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - become: runas + name: runas short_description: Run As user description: - This become plugins allows your remote/login user to execute commands as another user via the windows runas facility. diff --git a/lib/ansible/plugins/become/su.py b/lib/ansible/plugins/become/su.py index e200165567e..3d6a07b5b00 100644 --- a/lib/ansible/plugins/become/su.py +++ b/lib/ansible/plugins/become/su.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - become: su + name: su short_description: Substitute User description: - This become plugins allows your remote/login user to execute commands as another user via the su utility. diff --git a/lib/ansible/plugins/become/sudo.py b/lib/ansible/plugins/become/sudo.py index a7593cce95f..a4093b85f0b 100644 --- a/lib/ansible/plugins/become/sudo.py +++ b/lib/ansible/plugins/become/sudo.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - become: sudo + name: sudo short_description: Substitute User DO description: - This become plugins allows your remote/login user to execute commands as another user via the sudo utility. diff --git a/lib/ansible/plugins/cache/jsonfile.py b/lib/ansible/plugins/cache/jsonfile.py index 7605dc41112..7ee037292ea 100644 --- a/lib/ansible/plugins/cache/jsonfile.py +++ b/lib/ansible/plugins/cache/jsonfile.py @@ -7,7 +7,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' - cache: jsonfile + name: jsonfile short_description: JSON formatted files. description: - This cache uses JSON formatted, per host, files saved to the filesystem. diff --git a/lib/ansible/plugins/cache/memory.py b/lib/ansible/plugins/cache/memory.py index 1bccd544b2d..59f97b6eeda 100644 --- a/lib/ansible/plugins/cache/memory.py +++ b/lib/ansible/plugins/cache/memory.py @@ -7,7 +7,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' - cache: memory + name: memory short_description: RAM backed, non persistent description: - RAM backed cache that is not persistent. diff --git a/lib/ansible/plugins/callback/default.py b/lib/ansible/plugins/callback/default.py index b4b1d3873e1..e9fc2d9f7c7 100644 --- a/lib/ansible/plugins/callback/default.py +++ b/lib/ansible/plugins/callback/default.py @@ -6,7 +6,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' - callback: default + name: default type: stdout short_description: default Ansible screen output version_added: historical diff --git a/lib/ansible/plugins/callback/junit.py b/lib/ansible/plugins/callback/junit.py index 2fc892924d9..0b55ce72677 100644 --- a/lib/ansible/plugins/callback/junit.py +++ b/lib/ansible/plugins/callback/junit.py @@ -6,7 +6,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' - callback: junit + name: junit type: aggregate short_description: write playbook output to a JUnit file. version_added: historical diff --git a/lib/ansible/plugins/callback/minimal.py b/lib/ansible/plugins/callback/minimal.py index 8d3aef5b725..6fcb07d0484 100644 --- a/lib/ansible/plugins/callback/minimal.py +++ b/lib/ansible/plugins/callback/minimal.py @@ -7,7 +7,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' - callback: minimal + name: minimal type: stdout short_description: minimal Ansible screen output version_added: historical diff --git a/lib/ansible/plugins/callback/oneline.py b/lib/ansible/plugins/callback/oneline.py index 20b5be7f71c..fd51b27eeb8 100644 --- a/lib/ansible/plugins/callback/oneline.py +++ b/lib/ansible/plugins/callback/oneline.py @@ -7,7 +7,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' - callback: oneline + name: oneline type: stdout short_description: oneline Ansible screen output version_added: historical diff --git a/lib/ansible/plugins/callback/tree.py b/lib/ansible/plugins/callback/tree.py index 209afafc648..23892f39a6b 100644 --- a/lib/ansible/plugins/callback/tree.py +++ b/lib/ansible/plugins/callback/tree.py @@ -6,8 +6,8 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' - callback: tree - callback_type: notification + name: tree + type: notification requirements: - invoked in the command line short_description: Save host events to files diff --git a/lib/ansible/plugins/connection/local.py b/lib/ansible/plugins/connection/local.py index 297e3d32041..b328f48ac8c 100644 --- a/lib/ansible/plugins/connection/local.py +++ b/lib/ansible/plugins/connection/local.py @@ -6,7 +6,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' - connection: local + name: local short_description: execute on controller description: - This connection plugin allows ansible to execute tasks on the Ansible 'controller' instead of on a remote host. diff --git a/lib/ansible/plugins/connection/paramiko_ssh.py b/lib/ansible/plugins/connection/paramiko_ssh.py index 96a76d67461..7a3369b9250 100644 --- a/lib/ansible/plugins/connection/paramiko_ssh.py +++ b/lib/ansible/plugins/connection/paramiko_ssh.py @@ -6,7 +6,7 @@ __metaclass__ = type DOCUMENTATION = """ author: Ansible Core Team - connection: paramiko + name: paramiko short_description: Run tasks via python ssh (paramiko) description: - Use the python ssh implementation (Paramiko) to connect to targets diff --git a/lib/ansible/plugins/connection/psrp.py b/lib/ansible/plugins/connection/psrp.py index 1892a4d7d9c..403a70a5ae7 100644 --- a/lib/ansible/plugins/connection/psrp.py +++ b/lib/ansible/plugins/connection/psrp.py @@ -6,7 +6,7 @@ __metaclass__ = type DOCUMENTATION = """ author: Ansible Core Team -connection: psrp +name: psrp short_description: Run tasks over Microsoft PowerShell Remoting Protocol description: - Run commands or put/fetch on a target via PSRP (WinRM plugin) diff --git a/lib/ansible/plugins/connection/ssh.py b/lib/ansible/plugins/connection/ssh.py index ed44a035fe0..fd1a06bfefd 100644 --- a/lib/ansible/plugins/connection/ssh.py +++ b/lib/ansible/plugins/connection/ssh.py @@ -8,7 +8,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' - connection: ssh + name: ssh short_description: connect via ssh client binary description: - This connection plugin allows ansible to communicate to the target machines via normal ssh command line. diff --git a/lib/ansible/plugins/connection/winrm.py b/lib/ansible/plugins/connection/winrm.py index d7ead524f66..a3a7b681af6 100644 --- a/lib/ansible/plugins/connection/winrm.py +++ b/lib/ansible/plugins/connection/winrm.py @@ -7,7 +7,7 @@ __metaclass__ = type DOCUMENTATION = """ author: Ansible Core Team - connection: winrm + name: winrm short_description: Run tasks over Microsoft's WinRM description: - Run commands or put/fetch on a target via WinRM diff --git a/lib/ansible/plugins/inventory/advanced_host_list.py b/lib/ansible/plugins/inventory/advanced_host_list.py index dae0242780a..c61a4656cb4 100644 --- a/lib/ansible/plugins/inventory/advanced_host_list.py +++ b/lib/ansible/plugins/inventory/advanced_host_list.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' - inventory: advanced_host_list + name: advanced_host_list version_added: "2.4" short_description: Parses a 'host list' with ranges description: diff --git a/lib/ansible/plugins/inventory/auto.py b/lib/ansible/plugins/inventory/auto.py index ddcb705e28c..e30083ea8eb 100644 --- a/lib/ansible/plugins/inventory/auto.py +++ b/lib/ansible/plugins/inventory/auto.py @@ -6,7 +6,6 @@ __metaclass__ = type DOCUMENTATION = ''' name: auto - plugin_type: inventory author: - Matt Davis <@nitzmahone> version_added: "2.5" diff --git a/lib/ansible/plugins/inventory/constructed.py b/lib/ansible/plugins/inventory/constructed.py index 1e9c375b34b..424eb00e977 100644 --- a/lib/ansible/plugins/inventory/constructed.py +++ b/lib/ansible/plugins/inventory/constructed.py @@ -6,7 +6,6 @@ __metaclass__ = type DOCUMENTATION = ''' name: constructed - plugin_type: inventory version_added: "2.4" short_description: Uses Jinja2 to construct vars and groups based on existing inventory. description: diff --git a/lib/ansible/plugins/inventory/generator.py b/lib/ansible/plugins/inventory/generator.py index 4a7d3b7acb1..27575dd0c71 100644 --- a/lib/ansible/plugins/inventory/generator.py +++ b/lib/ansible/plugins/inventory/generator.py @@ -6,7 +6,6 @@ __metaclass__ = type DOCUMENTATION = ''' name: generator - plugin_type: inventory version_added: "2.6" short_description: Uses Jinja2 to construct hosts and groups from patterns description: diff --git a/lib/ansible/plugins/inventory/host_list.py b/lib/ansible/plugins/inventory/host_list.py index 4a7a98d8ce3..eee851653ec 100644 --- a/lib/ansible/plugins/inventory/host_list.py +++ b/lib/ansible/plugins/inventory/host_list.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = r''' - inventory: host_list + name: host_list version_added: "2.4" short_description: Parses a 'host list' string description: diff --git a/lib/ansible/plugins/inventory/ini.py b/lib/ansible/plugins/inventory/ini.py index 366171ea435..be9ec2fce96 100644 --- a/lib/ansible/plugins/inventory/ini.py +++ b/lib/ansible/plugins/inventory/ini.py @@ -4,7 +4,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' - inventory: ini + name: ini version_added: "2.4" short_description: Uses an Ansible INI file as inventory source. description: diff --git a/lib/ansible/plugins/inventory/script.py b/lib/ansible/plugins/inventory/script.py index b4094a569f2..d94f35d8fc6 100644 --- a/lib/ansible/plugins/inventory/script.py +++ b/lib/ansible/plugins/inventory/script.py @@ -6,7 +6,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' - inventory: script + name: script version_added: "2.4" short_description: Executes an inventory script that returns JSON options: diff --git a/lib/ansible/plugins/inventory/toml.py b/lib/ansible/plugins/inventory/toml.py index 7d134cabc16..50e1ced5568 100644 --- a/lib/ansible/plugins/inventory/toml.py +++ b/lib/ansible/plugins/inventory/toml.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = r''' - inventory: toml + name: toml version_added: "2.8" short_description: Uses a specific TOML file as an inventory source. description: diff --git a/lib/ansible/plugins/inventory/yaml.py b/lib/ansible/plugins/inventory/yaml.py index dc882c6d357..f927e00b791 100644 --- a/lib/ansible/plugins/inventory/yaml.py +++ b/lib/ansible/plugins/inventory/yaml.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' - inventory: yaml + name: yaml version_added: "2.4" short_description: Uses a specific YAML file as an inventory source. description: diff --git a/lib/ansible/plugins/lookup/config.py b/lib/ansible/plugins/lookup/config.py index b51f68158b8..cd0c8cbf2d7 100644 --- a/lib/ansible/plugins/lookup/config.py +++ b/lib/ansible/plugins/lookup/config.py @@ -4,7 +4,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: config + name: config author: Ansible Core version_added: "2.5" short_description: Lookup current Ansible configuration values diff --git a/lib/ansible/plugins/lookup/csvfile.py b/lib/ansible/plugins/lookup/csvfile.py index afd26c36baa..272b4a77679 100644 --- a/lib/ansible/plugins/lookup/csvfile.py +++ b/lib/ansible/plugins/lookup/csvfile.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: csvfile + name: csvfile author: Jan-Piet Mens (@jpmens) version_added: "1.5" short_description: read data from a TSV or CSV file diff --git a/lib/ansible/plugins/lookup/dict.py b/lib/ansible/plugins/lookup/dict.py index 95480a33188..5a83d9e8a13 100644 --- a/lib/ansible/plugins/lookup/dict.py +++ b/lib/ansible/plugins/lookup/dict.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: dict + name: dict version_added: "1.5" short_description: returns key/value pair items from dictionaries description: diff --git a/lib/ansible/plugins/lookup/env.py b/lib/ansible/plugins/lookup/env.py index bb0fae5f485..154e7553da2 100644 --- a/lib/ansible/plugins/lookup/env.py +++ b/lib/ansible/plugins/lookup/env.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: env + name: env author: Jan-Piet Mens (@jpmens) version_added: "0.9" short_description: Read the value of environment variables diff --git a/lib/ansible/plugins/lookup/file.py b/lib/ansible/plugins/lookup/file.py index 029b1796a1b..03ccad9a276 100644 --- a/lib/ansible/plugins/lookup/file.py +++ b/lib/ansible/plugins/lookup/file.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: file + name: file author: Daniel Hokka Zakrisson version_added: "0.9" short_description: read file contents diff --git a/lib/ansible/plugins/lookup/fileglob.py b/lib/ansible/plugins/lookup/fileglob.py index af424b310d5..8b51e768fca 100644 --- a/lib/ansible/plugins/lookup/fileglob.py +++ b/lib/ansible/plugins/lookup/fileglob.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: fileglob + name: fileglob author: Michael DeHaan version_added: "1.4" short_description: list files matching a pattern diff --git a/lib/ansible/plugins/lookup/first_found.py b/lib/ansible/plugins/lookup/first_found.py index e9dd957290e..b25f2177345 100644 --- a/lib/ansible/plugins/lookup/first_found.py +++ b/lib/ansible/plugins/lookup/first_found.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: first_found + name: first_found author: Seth Vidal version_added: historical short_description: return first file found from list diff --git a/lib/ansible/plugins/lookup/indexed_items.py b/lib/ansible/plugins/lookup/indexed_items.py index 42a30fe47fe..8ec6c41380e 100644 --- a/lib/ansible/plugins/lookup/indexed_items.py +++ b/lib/ansible/plugins/lookup/indexed_items.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: indexed_items + name: indexed_items author: Michael DeHaan version_added: "1.3" short_description: rewrites lists to return 'indexed items' diff --git a/lib/ansible/plugins/lookup/ini.py b/lib/ansible/plugins/lookup/ini.py index 10b691d4f37..6686d5adf17 100644 --- a/lib/ansible/plugins/lookup/ini.py +++ b/lib/ansible/plugins/lookup/ini.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: ini + name: ini author: Yannig Perre version_added: "2.0" short_description: read data from a ini file diff --git a/lib/ansible/plugins/lookup/inventory_hostnames.py b/lib/ansible/plugins/lookup/inventory_hostnames.py index 0d10dc5a439..b5e2e31c7ff 100644 --- a/lib/ansible/plugins/lookup/inventory_hostnames.py +++ b/lib/ansible/plugins/lookup/inventory_hostnames.py @@ -7,7 +7,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: inventory_hostnames + name: inventory_hostnames author: - Michael DeHaan - Steven Dossett diff --git a/lib/ansible/plugins/lookup/items.py b/lib/ansible/plugins/lookup/items.py index 6a4299e70b7..db6d48a51d1 100644 --- a/lib/ansible/plugins/lookup/items.py +++ b/lib/ansible/plugins/lookup/items.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: items + name: items author: Michael DeHaan version_added: historical short_description: list of items diff --git a/lib/ansible/plugins/lookup/lines.py b/lib/ansible/plugins/lookup/lines.py index 6a10cfcccac..56638c00b0c 100644 --- a/lib/ansible/plugins/lookup/lines.py +++ b/lib/ansible/plugins/lookup/lines.py @@ -6,7 +6,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: lines + name: lines author: Daniel Hokka Zakrisson version_added: "0.9" short_description: read lines from command diff --git a/lib/ansible/plugins/lookup/list.py b/lib/ansible/plugins/lookup/list.py index 05a890c496d..f4576e0da1b 100644 --- a/lib/ansible/plugins/lookup/list.py +++ b/lib/ansible/plugins/lookup/list.py @@ -7,7 +7,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: list + name: list author: Ansible core team version_added: "2.0" short_description: simply returns what it is given. diff --git a/lib/ansible/plugins/lookup/nested.py b/lib/ansible/plugins/lookup/nested.py index 45304b7be5a..e38a0f5cec2 100644 --- a/lib/ansible/plugins/lookup/nested.py +++ b/lib/ansible/plugins/lookup/nested.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: nested + name: nested version_added: "1.1" short_description: composes a list with nested elements of other lists description: diff --git a/lib/ansible/plugins/lookup/password.py b/lib/ansible/plugins/lookup/password.py index e1d9b3db80c..1102de19562 100644 --- a/lib/ansible/plugins/lookup/password.py +++ b/lib/ansible/plugins/lookup/password.py @@ -7,7 +7,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: password + name: password version_added: "1.1" author: - Daniel Hokka Zakrisson diff --git a/lib/ansible/plugins/lookup/pipe.py b/lib/ansible/plugins/lookup/pipe.py index 1045bbd30eb..1713b425896 100644 --- a/lib/ansible/plugins/lookup/pipe.py +++ b/lib/ansible/plugins/lookup/pipe.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = r""" - lookup: pipe + name: pipe author: Daniel Hokka Zakrisson version_added: "0.9" short_description: read output from a command diff --git a/lib/ansible/plugins/lookup/random_choice.py b/lib/ansible/plugins/lookup/random_choice.py index da2843a73e1..fc482d3a8e7 100644 --- a/lib/ansible/plugins/lookup/random_choice.py +++ b/lib/ansible/plugins/lookup/random_choice.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: random_choice + name: random_choice author: Michael DeHaan version_added: "1.1" short_description: return random element from list diff --git a/lib/ansible/plugins/lookup/sequence.py b/lib/ansible/plugins/lookup/sequence.py index 7312589ea24..e5e085525be 100644 --- a/lib/ansible/plugins/lookup/sequence.py +++ b/lib/ansible/plugins/lookup/sequence.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: sequence + name: sequence author: Jayson Vantuyl version_added: "1.0" short_description: generate a list based on a number sequence diff --git a/lib/ansible/plugins/lookup/subelements.py b/lib/ansible/plugins/lookup/subelements.py index a948f0204ef..f1670a1ff39 100644 --- a/lib/ansible/plugins/lookup/subelements.py +++ b/lib/ansible/plugins/lookup/subelements.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: subelements + name: subelements author: Serge van Ginderachter version_added: "1.4" short_description: traverse nested key from a list of dictionaries diff --git a/lib/ansible/plugins/lookup/template.py b/lib/ansible/plugins/lookup/template.py index cb4c8c670dd..160aea99f3f 100644 --- a/lib/ansible/plugins/lookup/template.py +++ b/lib/ansible/plugins/lookup/template.py @@ -6,7 +6,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: template + name: template author: Michael DeHaan version_added: "0.9" short_description: retrieve contents of file after templating with Jinja2 diff --git a/lib/ansible/plugins/lookup/together.py b/lib/ansible/plugins/lookup/together.py index 3c03cf7a161..b2deb911b1f 100644 --- a/lib/ansible/plugins/lookup/together.py +++ b/lib/ansible/plugins/lookup/together.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: together + name: together author: Bradley Young version_added: '1.3' short_description: merges lists into synchronized list diff --git a/lib/ansible/plugins/lookup/unvault.py b/lib/ansible/plugins/lookup/unvault.py index 18438da8805..2c43c784edc 100644 --- a/lib/ansible/plugins/lookup/unvault.py +++ b/lib/ansible/plugins/lookup/unvault.py @@ -4,7 +4,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: unvault + name: unvault author: ansible core team version_added: "2.10" short_description: read vaulted file(s) contents diff --git a/lib/ansible/plugins/lookup/url.py b/lib/ansible/plugins/lookup/url.py index 1c24ebf8e5f..7990d31ab35 100644 --- a/lib/ansible/plugins/lookup/url.py +++ b/lib/ansible/plugins/lookup/url.py @@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ -lookup: url +name: url author: Brian Coca (@bcoca) version_added: "1.9" short_description: return contents from URL diff --git a/lib/ansible/plugins/lookup/varnames.py b/lib/ansible/plugins/lookup/varnames.py index 17c1789a651..abe5ce861da 100644 --- a/lib/ansible/plugins/lookup/varnames.py +++ b/lib/ansible/plugins/lookup/varnames.py @@ -4,7 +4,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: varnames + name: varnames author: Ansible Core version_added: "2.8" short_description: Lookup matching variable names diff --git a/lib/ansible/plugins/lookup/vars.py b/lib/ansible/plugins/lookup/vars.py index 9132a5a5511..478fcb7bafa 100644 --- a/lib/ansible/plugins/lookup/vars.py +++ b/lib/ansible/plugins/lookup/vars.py @@ -4,7 +4,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - lookup: vars + name: vars author: Ansible Core version_added: "2.5" short_description: Lookup templated value of variables diff --git a/lib/ansible/plugins/shell/cmd.py b/lib/ansible/plugins/shell/cmd.py index d83aa11515f..e73c6719548 100644 --- a/lib/ansible/plugins/shell/cmd.py +++ b/lib/ansible/plugins/shell/cmd.py @@ -5,7 +5,6 @@ __metaclass__ = type DOCUMENTATION = ''' name: cmd -plugin_type: shell version_added: '2.8' short_description: Windows Command Prompt description: diff --git a/lib/ansible/plugins/shell/powershell.py b/lib/ansible/plugins/shell/powershell.py index 7eeb4e0928b..d0f33ac1eff 100644 --- a/lib/ansible/plugins/shell/powershell.py +++ b/lib/ansible/plugins/shell/powershell.py @@ -6,7 +6,6 @@ __metaclass__ = type DOCUMENTATION = ''' name: powershell -plugin_type: shell version_added: historical short_description: Windows PowerShell description: diff --git a/lib/ansible/plugins/shell/sh.py b/lib/ansible/plugins/shell/sh.py index 76a386f77a9..5b13a015a23 100644 --- a/lib/ansible/plugins/shell/sh.py +++ b/lib/ansible/plugins/shell/sh.py @@ -6,7 +6,6 @@ __metaclass__ = type DOCUMENTATION = ''' name: sh -plugin_type: shell short_description: "POSIX shell (/bin/sh)" version_added: historical description: diff --git a/lib/ansible/plugins/strategy/debug.py b/lib/ansible/plugins/strategy/debug.py index 5daea894b2e..bf15ff6911a 100644 --- a/lib/ansible/plugins/strategy/debug.py +++ b/lib/ansible/plugins/strategy/debug.py @@ -16,7 +16,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' - strategy: debug + name: debug short_description: Executes tasks in interactive debug session. description: - Task execution is 'linear' but controlled by an interactive debug session. diff --git a/lib/ansible/plugins/strategy/free.py b/lib/ansible/plugins/strategy/free.py index 7ed21183cf6..455aaa049ef 100644 --- a/lib/ansible/plugins/strategy/free.py +++ b/lib/ansible/plugins/strategy/free.py @@ -19,7 +19,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' - strategy: free + name: free short_description: Executes tasks without waiting for all hosts description: - Task execution is as fast as possible per batch as defined by C(serial) (default all). diff --git a/lib/ansible/plugins/strategy/host_pinned.py b/lib/ansible/plugins/strategy/host_pinned.py index ba293d36513..70f22eb8497 100644 --- a/lib/ansible/plugins/strategy/host_pinned.py +++ b/lib/ansible/plugins/strategy/host_pinned.py @@ -19,7 +19,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' - strategy: host_pinned + name: host_pinned short_description: Executes tasks on each host without interruption description: - Task execution is as fast as possible per host in batch as defined by C(serial) (default all). diff --git a/lib/ansible/plugins/strategy/linear.py b/lib/ansible/plugins/strategy/linear.py index ca70476e728..00458695173 100644 --- a/lib/ansible/plugins/strategy/linear.py +++ b/lib/ansible/plugins/strategy/linear.py @@ -19,7 +19,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' - strategy: linear + name: linear short_description: Executes tasks in a linear fashion description: - Task execution is in lockstep per host batch as defined by C(serial) (default all). diff --git a/lib/ansible/plugins/vars/host_group_vars.py b/lib/ansible/plugins/vars/host_group_vars.py index 377a77de7a4..7bdfe332c80 100644 --- a/lib/ansible/plugins/vars/host_group_vars.py +++ b/lib/ansible/plugins/vars/host_group_vars.py @@ -19,7 +19,7 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = ''' - vars: host_group_vars + name: host_group_vars version_added: "2.4" short_description: In charge of loading group_vars and host_vars requirements: