summaryrefslogtreecommitdiff
path: root/lib/ansible/plugins
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/plugins')
-rw-r--r--lib/ansible/plugins/callback/tree.py4
-rw-r--r--lib/ansible/plugins/connection/ssh.py16
-rw-r--r--lib/ansible/plugins/connection/winrm.py2
-rw-r--r--lib/ansible/plugins/doc_fragments/default_callback.py4
-rw-r--r--lib/ansible/plugins/doc_fragments/shell_common.py2
-rw-r--r--lib/ansible/plugins/inventory/ini.py4
-rw-r--r--lib/ansible/plugins/lookup/inventory_hostnames.py2
-rw-r--r--lib/ansible/plugins/lookup/sequence.py4
8 files changed, 19 insertions, 19 deletions
diff --git a/lib/ansible/plugins/callback/tree.py b/lib/ansible/plugins/callback/tree.py
index e7682d5f17..da9c767aa5 100644
--- a/lib/ansible/plugins/callback/tree.py
+++ b/lib/ansible/plugins/callback/tree.py
@@ -15,7 +15,7 @@ DOCUMENTATION = '''
options:
directory:
version_added: '2.11'
- description: directory that will contain the per host JSON files. Also set by the ``--tree`` option when using adhoc.
+ description: directory that will contain the per host JSON files. Also set by the C(--tree) option when using adhoc.
ini:
- section: callback_tree
key: directory
@@ -24,7 +24,7 @@ DOCUMENTATION = '''
default: "~/.ansible/tree"
type: path
description:
- - "This callback is used by the Ansible (adhoc) command line option `-t|--tree`"
+ - "This callback is used by the Ansible (adhoc) command line option C(-t|--tree)."
- This produces a JSON dump of events in a directory, a file for each host, the directory used MUST be passed as a command line option.
'''
diff --git a/lib/ansible/plugins/connection/ssh.py b/lib/ansible/plugins/connection/ssh.py
index 08e90ce081..a4ad38e428 100644
--- a/lib/ansible/plugins/connection/ssh.py
+++ b/lib/ansible/plugins/connection/ssh.py
@@ -59,7 +59,7 @@ DOCUMENTATION = '''
sshpass_prompt:
description:
- Password prompt that sshpass should search for. Supported by sshpass 1.06 and up.
- - Defaults to ``Enter PIN for`` when pkcs11_provider is set.
+ - Defaults to C(Enter PIN for) when pkcs11_provider is set.
default: ''
ini:
- section: 'ssh_connection'
@@ -131,7 +131,7 @@ DOCUMENTATION = '''
- name: ansible_scp_executable
version_added: '2.7'
scp_extra_args:
- description: Extra exclusive to the ``scp`` CLI
+ description: Extra exclusive to the C(scp) CLI
vars:
- name: ansible_scp_extra_args
env:
@@ -145,7 +145,7 @@ DOCUMENTATION = '''
- name: scp_extra_args
default: ''
sftp_extra_args:
- description: Extra exclusive to the ``sftp`` CLI
+ description: Extra exclusive to the C(sftp) CLI
vars:
- name: ansible_sftp_extra_args
env:
@@ -242,9 +242,9 @@ DOCUMENTATION = '''
control_path:
description:
- This is the location to save SSH's ControlPath sockets, it uses SSH's variable substitution.
- - Since 2.3, if null (default), ansible will generate a unique hash. Use `%(directory)s` to indicate where to use the control dir path setting.
- - Before 2.3 it defaulted to `control_path=%(directory)s/ansible-ssh-%%h-%%p-%%r`.
- - Be aware that this setting is ignored if `-o ControlPath` is set in ssh args.
+ - Since 2.3, if null (default), ansible will generate a unique hash. Use ``%(directory)s`` to indicate where to use the control dir path setting.
+ - Before 2.3 it defaulted to ``control_path=%(directory)s/ansible-ssh-%%h-%%p-%%r``.
+ - Be aware that this setting is ignored if C(-o ControlPath) is set in ssh args.
env:
- name: ANSIBLE_SSH_CONTROL_PATH
ini:
@@ -257,7 +257,7 @@ DOCUMENTATION = '''
default: ~/.ansible/cp
description:
- This sets the directory to use for ssh control path if the control path setting is null.
- - Also, provides the `%(directory)s` variable for the control path setting.
+ - Also, provides the ``%(directory)s`` variable for the control path setting.
env:
- name: ANSIBLE_SSH_CONTROL_PATH_DIR
ini:
@@ -280,7 +280,7 @@ DOCUMENTATION = '''
description:
- "Preferred method to use when transferring files over ssh"
- Setting to 'smart' (default) will try them in order, until one succeeds or they all fail
- - Using 'piped' creates an ssh pipe with ``dd`` on either side to copy the data
+ - Using 'piped' creates an ssh pipe with C(dd) on either side to copy the data
choices: ['sftp', 'scp', 'piped', 'smart']
env: [{name: ANSIBLE_SSH_TRANSFER_METHOD}]
ini:
diff --git a/lib/ansible/plugins/connection/winrm.py b/lib/ansible/plugins/connection/winrm.py
index b8d7353661..827d9eaee9 100644
--- a/lib/ansible/plugins/connection/winrm.py
+++ b/lib/ansible/plugins/connection/winrm.py
@@ -12,7 +12,7 @@ DOCUMENTATION = """
description:
- Run commands or put/fetch on a target via WinRM
- This plugin allows extra arguments to be passed that are supported by the protocol but not explicitly defined here.
- They should take the form of variables declared with the following pattern `ansible_winrm_<option>`.
+ They should take the form of variables declared with the following pattern C(ansible_winrm_<option>).
version_added: "2.0"
extends_documentation_fragment:
- connection_pipelining
diff --git a/lib/ansible/plugins/doc_fragments/default_callback.py b/lib/ansible/plugins/doc_fragments/default_callback.py
index 4b10f20787..f9d862c1c5 100644
--- a/lib/ansible/plugins/doc_fragments/default_callback.py
+++ b/lib/ansible/plugins/doc_fragments/default_callback.py
@@ -18,9 +18,9 @@ class ModuleDocFragment(object):
env:
- name: DISPLAY_SKIPPED_HOSTS
deprecated:
- why: environment variables without "ANSIBLE_" prefix are deprecated
+ why: environment variables without C(ANSIBLE_) prefix are deprecated
version: "2.12"
- alternatives: the "ANSIBLE_DISPLAY_SKIPPED_HOSTS" environment variable
+ alternatives: the C(ANSIBLE_DISPLAY_SKIPPED_HOSTS) environment variable
- name: ANSIBLE_DISPLAY_SKIPPED_HOSTS
ini:
- key: display_skipped_hosts
diff --git a/lib/ansible/plugins/doc_fragments/shell_common.py b/lib/ansible/plugins/doc_fragments/shell_common.py
index 5b018000bf..628cc2188d 100644
--- a/lib/ansible/plugins/doc_fragments/shell_common.py
+++ b/lib/ansible/plugins/doc_fragments/shell_common.py
@@ -35,7 +35,7 @@ options:
system_tmpdirs:
description:
- "List of valid system temporary directories on the managed machine for Ansible to choose
- when it cannot use ``remote_tmp``, normally due to permission issues. These must be world
+ when it cannot use C(remote_tmp), normally due to permission issues. These must be world
readable, writable, and executable. This list should only contain directories which the
system administrator has pre-created with the proper ownership and permissions otherwise
security issues can arise."
diff --git a/lib/ansible/plugins/inventory/ini.py b/lib/ansible/plugins/inventory/ini.py
index 6518f8a3c1..fa8fdc4b09 100644
--- a/lib/ansible/plugins/inventory/ini.py
+++ b/lib/ansible/plugins/inventory/ini.py
@@ -8,13 +8,13 @@ DOCUMENTATION = '''
version_added: "2.4"
short_description: Uses an Ansible INI file as inventory source.
description:
- - INI file based inventory, sections are groups or group related with special `:modifiers`.
+ - INI file based inventory, sections are groups or group related with special C(:modifiers).
- Entries in sections C([group_1]) are hosts, members of the group.
- Hosts can have variables defined inline as key/value pairs separated by C(=).
- The C(children) modifier indicates that the section contains groups.
- The C(vars) modifier indicates that the section contains variables assigned to members of the group.
- Anything found outside a section is considered an 'ungrouped' host.
- - Values passed in the INI format using the ``key=value`` syntax are interpreted differently depending on where they are declared within your inventory.
+ - Values passed in the INI format using the C(key=value) syntax are interpreted differently depending on where they are declared within your inventory.
- When declared inline with the host, INI values are processed by Python's ast.literal_eval function
(U(https://docs.python.org/3/library/ast.html#ast.literal_eval)) and interpreted as Python literal structures
(strings, numbers, tuples, lists, dicts, booleans, None). Host lines accept multiple C(key=value) parameters per line.
diff --git a/lib/ansible/plugins/lookup/inventory_hostnames.py b/lib/ansible/plugins/lookup/inventory_hostnames.py
index a3cff92ea9..f8432752a3 100644
--- a/lib/ansible/plugins/lookup/inventory_hostnames.py
+++ b/lib/ansible/plugins/lookup/inventory_hostnames.py
@@ -14,7 +14,7 @@ DOCUMENTATION = """
version_added: "1.3"
short_description: list of inventory hosts matching a host pattern
description:
- - "This lookup understands 'host patterns' as used by the `hosts:` keyword in plays
+ - "This lookup understands 'host patterns' as used by the C(hosts:) keyword in plays
and can return a list of matching hosts from inventory"
notes:
- this is only worth for 'hostname patterns' it is easier to loop over the group/group_names variables otherwise.
diff --git a/lib/ansible/plugins/lookup/sequence.py b/lib/ansible/plugins/lookup/sequence.py
index 7dac37bd52..3a2f38baed 100644
--- a/lib/ansible/plugins/lookup/sequence.py
+++ b/lib/ansible/plugins/lookup/sequence.py
@@ -15,8 +15,8 @@ DOCUMENTATION = """
- 'Arguments can be specified as key=value pair strings or as a shortcut form of the arguments string is also accepted: [start-]end[/stride][:format].'
- 'Numerical values can be specified in decimal, hexadecimal (0x3f8) or octal (0600).'
- Starting at version 1.9.2, negative strides are allowed.
- - Generated items are strings. Use Jinja2 filters to convert items to preferred type, e.g. ``{{ 1 + item|int }}``.
- - See also Jinja2 ``range`` filter as an alternative.
+ - Generated items are strings. Use Jinja2 filters to convert items to preferred type, e.g. C({{ 1 + item|int }}).
+ - See also Jinja2 C(range) filter as an alternative.
options:
start:
description: number at which to start the sequence
View Lorry Controller Status