ansible-core 2.17.5rc1__py3-none-any.whl → 2.18.0rc1__py3-none-any.whl

ansible/modules/package_facts.py

@@ -14,30 +14,43 @@ description:
 options:
   manager:
     description:
-      - The package manager used by the system so we can query the package information.
-      - Since 2.8 this is a list and can support multiple package managers per system.
-      - The 'portage' and 'pkg' options were added in version 2.8.
-      - The 'apk' option was added in version 2.11.
-      - The 'pkg_info' option was added in version 2.13.
+      - The package manager(s) used by the system so we can query the package information.
+        This is a list and can support multiple package managers per system, since version 2.8.
+      - The V(portage) and V(pkg) options were added in version 2.8.
+      - The V(apk) option was added in version 2.11.
+      - The V(pkg_info)' option was added in version 2.13.
+      - Aliases were added in 2.18, to support using C(manager={{ansible_facts['pkg_mgr']}})
     default: ['auto']
-    choices: ['auto', 'rpm', 'apt', 'portage', 'pkg', 'pacman', 'apk', 'pkg_info']
+    choices:
+        auto: Depending on O(strategy), will match the first or all package managers provided, in order
+        rpm: For RPM based distros, requires RPM Python bindings, not installed by default on Suse (python3-rpm)
+        yum: Alias to rpm
+        dnf: Alias to rpm
+        dnf5: Alias to rpm
+        zypper: Alias to rpm
+        apt: For DEB based distros, C(python-apt) package must be installed on targeted hosts
+        portage: Handles ebuild packages, it requires the C(qlist) utility, which is part of 'app-portage/portage-utils'
+        pkg: libpkg front end (FreeBSD)
+        pkg5: Alias to pkg
+        pkgng: Alias to pkg
+        pacman: Archlinux package manager/builder
+        apk: Alpine Linux package manager
+        pkg_info: OpenBSD package manager
+        openbsd_pkg: Alias to pkg_info
     type: list
     elements: str
   strategy:
     description:
       - This option controls how the module queries the package managers on the system.
-        V(first) means it will return only information for the first supported package manager available.
-        V(all) will return information for all supported and available package managers on the system.
-    choices: ['first', 'all']
+    choices:
+        first: returns only information for the first supported package manager available.
+        all: returns information for all supported and available package managers on the system.
     default: 'first'
     type: str
     version_added: "2.8"
 version_added: "2.5"
 requirements:
-    - For 'portage' support it requires the C(qlist) utility, which is part of 'app-portage/portage-utils'.
-    - For Debian-based systems C(python-apt) package must be installed on targeted hosts.
-    - For SUSE-based systems C(python3-rpm) package must be installed on targeted hosts.
-      This package is required because SUSE does not include RPM Python bindings by default.
+    - See details per package manager in the O(manager) option.
 author:
   - Matthew Jones (@matburt)
   - Brian Coca (@bcoca)
@@ -240,16 +253,26 @@ ansible_facts:
 import re
 
 from ansible.module_utils.common.text.converters import to_native, to_text
-from ansible.module_utils.basic import AnsibleModule, missing_required_lib
+from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.common.locale import get_best_parsable_locale
-from ansible.module_utils.common.process import get_bin_path
-from ansible.module_utils.common.respawn import has_respawned, probe_interpreters_for_module, respawn_module
-from ansible.module_utils.facts.packages import LibMgr, CLIMgr, get_all_pkg_managers
+from ansible.module_utils.facts.packages import CLIMgr, RespawningLibMgr, get_all_pkg_managers
 
 
-class RPM(LibMgr):
+ALIASES = {
+    'rpm': ['dnf', 'dnf5', 'yum' , 'zypper'],
+    'pkg': ['pkg5', 'pkgng'],
+    'pkg_info': ['openbsd_pkg'],
+}
+
+
+class RPM(RespawningLibMgr):
 
     LIB = 'rpm'
+    CLI_BINARIES = ['rpm']
+    INTERPRETERS = [
+        '/usr/libexec/platform-python',
+        '/usr/bin/python3',
+    ]
 
     def list_installed(self):
         return self._lib.TransactionSet().dbMatch()
@@ -261,34 +284,11 @@ class RPM(LibMgr):
                     epoch=package[self._lib.RPMTAG_EPOCH],
                     arch=package[self._lib.RPMTAG_ARCH],)
 
-    def is_available(self):
-        ''' we expect the python bindings installed, but this gives warning if they are missing and we have rpm cli'''
-        we_have_lib = super(RPM, self).is_available()
-
-        try:
-            get_bin_path('rpm')
-
-            if not we_have_lib and not has_respawned():
-                # try to locate an interpreter with the necessary lib
-                interpreters = ['/usr/libexec/platform-python',
-                                '/usr/bin/python3',
-                                '/usr/bin/python2']
-                interpreter_path = probe_interpreters_for_module(interpreters, self.LIB)
-                if interpreter_path:
-                    respawn_module(interpreter_path)
-                    # end of the line for this process; this module will exit when the respawned copy completes
 
-            if not we_have_lib:
-                module.warn('Found "rpm" but %s' % (missing_required_lib(self.LIB)))
-        except ValueError:
-            pass
-
-        return we_have_lib
-
-
-class APT(LibMgr):
+class APT(RespawningLibMgr):
 
     LIB = 'apt'
+    CLI_BINARIES = ['apt', 'apt-get', 'aptitude']
 
     def __init__(self):
         self._cache = None
@@ -302,30 +302,6 @@ class APT(LibMgr):
         self._cache = self._lib.Cache()
         return self._cache
 
-    def is_available(self):
-        ''' we expect the python bindings installed, but if there is apt/apt-get give warning about missing bindings'''
-        we_have_lib = super(APT, self).is_available()
-        if not we_have_lib:
-            for exe in ('apt', 'apt-get', 'aptitude'):
-                try:
-                    get_bin_path(exe)
-                except ValueError:
-                    continue
-                else:
-                    if not has_respawned():
-                        # try to locate an interpreter with the necessary lib
-                        interpreters = ['/usr/bin/python3',
-                                        '/usr/bin/python2']
-                        interpreter_path = probe_interpreters_for_module(interpreters, self.LIB)
-                        if interpreter_path:
-                            respawn_module(interpreter_path)
-                            # end of the line for this process; this module will exit here when respawned copy completes
-
-                    module.warn('Found "%s" but %s' % (exe, missing_required_lib('apt')))
-                    break
-
-        return we_have_lib
-
     def list_installed(self):
         # Store the cache to avoid running pkg_cache() for each item in the comprehension, which is very slow
         cache = self.pkg_cache
@@ -485,9 +461,13 @@ def main():
     # get supported pkg managers
     PKG_MANAGERS = get_all_pkg_managers()
     PKG_MANAGER_NAMES = [x.lower() for x in PKG_MANAGERS.keys()]
+    # add aliases
+    PKG_MANAGER_NAMES.extend([alias for alist in ALIASES.values() for alias in alist])
 
     # start work
     global module
+
+    # choices are not set for 'manager' as they are computed dynamically and validated below instead of in argspec
     module = AnsibleModule(argument_spec=dict(manager={'type': 'list', 'elements': 'str', 'default': ['auto']},
                                               strategy={'choices': ['first', 'all'], 'default': 'first'}),
                            supports_check_mode=True)
@@ -513,29 +493,32 @@ def main():
     seen = set()
     for pkgmgr in managers:
 
-        if found and strategy == 'first':
+        if strategy == 'first' and found:
             break
 
+        # substitute aliases for aliased
+        for aliased in ALIASES.keys():
+            if pkgmgr in ALIASES[aliased]:
+                pkgmgr = aliased
+                break
+
         # dedupe as per above
         if pkgmgr in seen:
             continue
+
         seen.add(pkgmgr)
+
+        manager = PKG_MANAGERS[pkgmgr]()
         try:
-            try:
-                # manager throws exception on init (calls self.test) if not usable.
-                manager = PKG_MANAGERS[pkgmgr]()
-                if manager.is_available():
-                    found += 1
+            if manager.is_available(handle_exceptions=False):
+                found += 1
+                try:
                     packages.update(manager.get_packages())
-
-            except Exception as e:
-                if pkgmgr in module.params['manager']:
-                    module.warn('Requested package manager %s was not usable by this module: %s' % (pkgmgr, to_text(e)))
-                continue
-
+                except Exception as e:
+                    module.warn('Failed to retrieve packages with %s: %s' % (pkgmgr, to_text(e)))
         except Exception as e:
             if pkgmgr in module.params['manager']:
-                module.warn('Failed to retrieve packages with %s: %s' % (pkgmgr, to_text(e)))
+                module.warn('Requested package manager %s was not usable by this module: %s' % (pkgmgr, to_text(e)))
 
     if found == 0:
         msg = ('Could not detect a supported package manager from the following list: %s, '

ansible/modules/pause.py

@@ -29,11 +29,12 @@ options:
   prompt:
     description:
       - Optional text to use for the prompt message.
-      - User input is only returned if O(seconds=None) and O(minutes=None), otherwise this is just a custom message before playbook execution is paused.
+      - User input is only returned if O(seconds) and O(minutes) are both not specified,
+        otherwise this is just a custom message before playbook execution is paused.
   echo:
     description:
       - Controls whether or not keyboard input is shown when typing.
-      - Only has effect if O(seconds=None) and O(minutes=None).
+      - Only has effect if neither O(seconds) nor O(minutes) are set.
     type: bool
     default: 'yes'
     version_added: 2.5
@@ -62,7 +63,7 @@ attributes:
     platform:
         platforms: all
 notes:
-      - Starting in 2.2,  if you specify 0 or negative for minutes or seconds, it will wait for 1 second, previously it would wait indefinitely.
+      - Starting in 2.2, if you specify 0 or negative for minutes or seconds, it will wait for 1 second, previously it would wait indefinitely.
       - User input is not captured or echoed, regardless of echo setting, when minutes or seconds is specified.
 '''
 

ansible/modules/pip.py

@@ -28,21 +28,21 @@ options:
   requirements:
     description:
       - The path to a pip requirements file, which should be local to the remote system.
-        File can be specified as a relative path if using the chdir option.
+        File can be specified as a relative path if using the O(chdir) option.
     type: str
   virtualenv:
     description:
       - An optional path to a I(virtualenv) directory to install into.
-        It cannot be specified together with the 'executable' parameter
+        It cannot be specified together with the O(executable) parameter
         (added in 2.1).
         If the virtualenv does not exist, it will be created before installing
-        packages. The optional virtualenv_site_packages, virtualenv_command,
-        and virtualenv_python options affect the creation of the virtualenv.
+        packages. The optional O(virtualenv_site_packages), O(virtualenv_command),
+        and O(virtualenv_python) options affect the creation of the virtualenv.
     type: path
   virtualenv_site_packages:
     description:
       - Whether the virtual environment will inherit packages from the
-        global site-packages directory.  Note that if this setting is
+        global C(site-packages) directory. Note that if this setting is
         changed on an already existing virtual environment it will not
         have any effect, the environment must be deleted and newly
         created.
@@ -68,14 +68,14 @@ options:
     version_added: "2.0"
   state:
     description:
-      - The state of module
-      - The 'forcereinstall' option is only available in Ansible 2.1 and above.
+      - The state of module.
+      - The V(forcereinstall) option is only available in Ansible 2.1 and above.
     type: str
     choices: [ absent, forcereinstall, latest, present ]
     default: present
   extra_args:
     description:
-      - Extra arguments passed to pip.
+      - Extra arguments passed to C(pip).
     type: str
     version_added: "1.0"
   editable:
@@ -86,18 +86,18 @@ options:
     version_added: "2.0"
   chdir:
     description:
-      - cd into this directory before running the command
+      - cd into this directory before running the command.
     type: path
     version_added: "1.3"
   executable:
     description:
-      - The explicit executable or pathname for the pip executable,
+      - The explicit executable or pathname for the C(pip) executable,
         if different from the Ansible Python interpreter. For
         example V(pip3.3), if there are both Python 2.7 and 3.3 installations
         in the system and you want to run pip for the Python 3.3 installation.
       - Mutually exclusive with O(virtualenv) (added in 2.1).
       - Does not affect the Ansible Python interpreter.
-      - The setuptools package must be installed for both the Ansible Python interpreter
+      - The C(setuptools) package must be installed for both the Ansible Python interpreter
         and for the version of Python specified by this option.
     type: path
     version_added: "1.3"
@@ -105,14 +105,14 @@ options:
     description:
       - The system umask to apply before installing the pip package. This is
         useful, for example, when installing on systems that have a very
-        restrictive umask by default (e.g., "0077") and you want to pip install
+        restrictive umask by default (e.g., C(0077)) and you want to C(pip install)
         packages which are to be used by all users. Note that this requires you
-        to specify desired umask mode as an octal string, (e.g., "0022").
+        to specify desired umask mode as an octal string, (e.g., C(0022)).
     type: str
     version_added: "2.1"
   break_system_packages:
     description:
-      - Allow pip to modify an externally-managed Python installation as defined by PEP 668.
+      - Allow C(pip) to modify an externally-managed Python installation as defined by PEP 668.
       - This is typically required when installing packages outside a virtual environment on modern systems.
     type: bool
     default: false

ansible/modules/replace.py

@@ -93,10 +93,6 @@ options:
         get the original file back if you somehow clobbered it incorrectly.
     type: bool
     default: no
-  others:
-    description:
-      - All arguments accepted by the M(ansible.builtin.file) module also work here.
-    type: str
   encoding:
     description:
       - The character encoding for reading and writing the file.
@@ -246,6 +242,7 @@ def main():
     path = params['path']
     encoding = params['encoding']
     res_args = dict(rc=0)
+    contents = None
 
     params['after'] = to_text(params['after'], errors='surrogate_or_strict', nonstring='passthru')
     params['before'] = to_text(params['before'], errors='surrogate_or_strict', nonstring='passthru')

ansible/modules/rpm_key.py

@@ -15,7 +15,7 @@ author:
   - Hector Acosta (@hacosta) <hector.acosta@gazzang.com>
 short_description: Adds or removes a gpg key from the rpm db
 description:
-  - Adds or removes (rpm --import) a gpg key to your rpm database.
+  - Adds or removes C(rpm --import) a gpg key to your rpm database.
 version_added: "1.3"
 options:
     key:
@@ -40,7 +40,8 @@ options:
       description:
         - The long-form fingerprint of the key being imported.
         - This will be used to verify the specified key.
-      type: str
+      type: list
+      elements: str
       version_added: 2.9
 extends_documentation_fragment:
     - action_common_attributes
@@ -73,6 +74,13 @@ EXAMPLES = '''
   ansible.builtin.rpm_key:
     key: /path/to/RPM-GPG-KEY.dag.txt
     fingerprint: EBC6 E12C 62B1 C734 026B  2122 A20E 5214 6B8D 79E6
+
+- name: Verify the key, using multiple fingerprints, before import
+  ansible.builtin.rpm_key:
+    key: /path/to/RPM-GPG-KEY.dag.txt
+    fingerprint:
+      - EBC6 E12C 62B1 C734 026B  2122 A20E 5214 6B8D 79E6
+      - 19B7 913E 6284 8E3F 4D78 D6B4 ECD9 1AB2 2EB6 8D86
 '''
 
 RETURN = r'''#'''
@@ -105,8 +113,12 @@ class RpmKey(object):
         state = module.params['state']
         key = module.params['key']
         fingerprint = module.params['fingerprint']
+        fingerprints = set()
+
         if fingerprint:
-            fingerprint = fingerprint.replace(' ', '').upper()
+            if not isinstance(fingerprint, list):
+                fingerprint = [fingerprint]
+            fingerprints = set(f.replace(' ', '').upper() for f in fingerprint)
 
         self.gpg = self.module.get_bin_path('gpg')
         if not self.gpg:
@@ -131,11 +143,12 @@ class RpmKey(object):
             else:
                 if not keyfile:
                     self.module.fail_json(msg="When importing a key, a valid file must be given")
-                if fingerprint:
-                    has_fingerprint = self.getfingerprint(keyfile)
-                    if fingerprint != has_fingerprint:
+                if fingerprints:
+                    keyfile_fingerprints = self.getfingerprints(keyfile)
+                    if not fingerprints.issubset(keyfile_fingerprints):
                         self.module.fail_json(
-                            msg="The specified fingerprint, '%s', does not match the key fingerprint '%s'" % (fingerprint, has_fingerprint)
+                            msg=("The specified fingerprint, '%s', "
+                                 "does not match any key fingerprints in '%s'") % (fingerprints, keyfile_fingerprints)
                         )
                 self.import_key(keyfile)
                 if should_cleanup_keyfile:
@@ -183,11 +196,15 @@ class RpmKey(object):
 
         self.module.fail_json(msg="Unexpected gpg output")
 
-    def getfingerprint(self, keyfile):
+    def getfingerprints(self, keyfile):
         stdout, stderr = self.execute_command([
             self.gpg, '--no-tty', '--batch', '--with-colons',
-            '--fixed-list-mode', '--with-fingerprint', keyfile
+            '--fixed-list-mode', '--import', '--import-options', 'show-only',
+            '--dry-run', keyfile
         ])
+
+        fingerprints = set()
+
         for line in stdout.splitlines():
             line = line.strip()
             if line.startswith('fpr:'):
@@ -199,7 +216,10 @@ class RpmKey(object):
                 #
                 # "fpr :: Fingerprint (fingerprint is in field 10)"
                 #
-                return line.split(':')[9]
+                fingerprints.add(line.split(':')[9])
+
+        if fingerprints:
+            return fingerprints
 
         self.module.fail_json(msg="Unexpected gpg output")
 
@@ -239,7 +259,7 @@ def main():
         argument_spec=dict(
             state=dict(type='str', default='present', choices=['absent', 'present']),
             key=dict(type='str', required=True, no_log=False),
-            fingerprint=dict(type='str'),
+            fingerprint=dict(type='list', elements='str'),
             validate_certs=dict(type='bool', default=True),
         ),
         supports_check_mode=True,

ansible/modules/service.py

@@ -35,8 +35,8 @@ options:
             commands unless necessary.
           - V(restarted) will always bounce the service.
           - V(reloaded) will always reload.
-          - B(At least one of state and enabled are required.)
-          - Note that reloaded will start the service if it is not already started,
+          - At least one of O(state) and O(enabled) are required.
+          - Note that V(reloaded) will start the service if it is not already started,
             even if your chosen init system wouldn't normally.
         type: str
         choices: [ reloaded, restarted, started, stopped ]
@@ -52,7 +52,7 @@ options:
     pattern:
         description:
         - If the service does not respond to the status command, name a
-          substring to look for as would be found in the output of the I(ps)
+          substring to look for as would be found in the output of the C(ps)
           command as a stand-in for a status result.
         - If the string is found, the service will be assumed to be started.
         - While using remote hosts with systemd this setting will be ignored.
@@ -61,7 +61,7 @@ options:
     enabled:
         description:
         - Whether the service should start on boot.
-        - B(At least one of state and enabled are required.)
+        - At least one of O(state) and O(enabled) are required.
         type: bool
     runlevel:
         description:
@@ -80,7 +80,7 @@ options:
     use:
         description:
         - The service module actually uses system specific modules, normally through auto detection, this setting can force a specific module.
-        - Normally it uses the value of the 'ansible_service_mgr' fact and falls back to the old 'service' module when none matching is found.
+        - Normally it uses the value of the C(ansible_service_mgr) fact and falls back to the C(ansible.legacy.service) module when none matching is found.
         - The 'old service module' still uses autodetection and in no way does it correspond to the C(service) command.
         type: str
         default: auto
@@ -1012,7 +1012,7 @@ class FreeBsdService(Service):
         self.sysrc_cmd = self.module.get_bin_path('sysrc')
 
     def get_service_status(self):
-        rc, stdout, stderr = self.execute_command("%s %s %s %s" % (self.svc_cmd, self.name, 'onestatus', self.arguments))
+        rc, stdout, stderr = self.execute_command("%s %s %s %s" % (self.svc_cmd, self.arguments, self.name, 'onestatus'))
         if self.name == "pf":
             self.running = "Enabled" in stdout
         else:
@@ -1032,7 +1032,7 @@ class FreeBsdService(Service):
             if os.path.isfile(rcfile):
                 self.rcconf_file = rcfile
 
-        rc, stdout, stderr = self.execute_command("%s %s %s %s" % (self.svc_cmd, self.name, 'rcvar', self.arguments))
+        rc, stdout, stderr = self.execute_command("%s %s %s %s" % (self.svc_cmd, self.arguments, self.name, 'rcvar'))
         try:
             rcvars = shlex.split(stdout, comments=True)
         except Exception:
@@ -1097,7 +1097,7 @@ class FreeBsdService(Service):
         if self.action == "reload":
             self.action = "onereload"
 
-        ret = self.execute_command("%s %s %s %s" % (self.svc_cmd, self.name, self.action, self.arguments))
+        ret = self.execute_command("%s %s %s %s" % (self.svc_cmd, self.arguments, self.name, self.action))
 
         if self.sleep:
             time.sleep(self.sleep)

ansible/modules/service_facts.py

@@ -45,6 +45,19 @@ EXAMPLES = r'''
 - name: Print service facts
   ansible.builtin.debug:
     var: ansible_facts.services
+
+- name: show names of existing systemd services, sometimes systemd knows about services that were never installed
+  debug: msg={{ existing_systemd_services | map(attribute='name') }}
+  vars:
+     known_systemd_services: "{{ ansible_facts['services'].values() | selectattr('source', 'equalto', 'systemd') }}"
+     existing_systemd_services: "{{ known_systemd_services | rejectattr('status', 'equalto', 'not-found') }}"
+
+- name: restart systemd service if it exists
+  service:
+    state: restarted
+    name: ntpd.service
+  when: ansible_facts['services']['ntpd.service']['status'] | default('not-found') != 'not-found'
+
 '''
 
 RETURN = r'''
@@ -250,7 +263,7 @@ class SystemctlScanService(BaseService):
     def _list_from_units(self, systemctl_path, services):
 
         # list units as systemd sees them
-        rc, stdout, stderr = self.module.run_command("%s list-units --no-pager --type service --all" % systemctl_path, use_unsafe_shell=True)
+        rc, stdout, stderr = self.module.run_command("%s list-units --no-pager --type service --all --plain" % systemctl_path, use_unsafe_shell=True)
         if rc != 0:
             self.module.warn("Could not list units from systemd: %s" % stderr)
         else:
@@ -259,16 +272,18 @@ class SystemctlScanService(BaseService):
                 state_val = "stopped"
                 status_val = "unknown"
                 fields = line.split()
+
+                # systemd sometimes gives misleading status
+                # check all fields for bad states
                 for bad in self.BAD_STATES:
-                    if bad in fields:  # dot is 0
+                    # except description
+                    if bad in fields[:-1]:
                         status_val = bad
-                        fields = fields[1:]
                         break
                 else:
                     # active/inactive
                     status_val = fields[2]
 
-                # array is normalize so predictable now
                 service_name = fields[0]
                 if fields[3] == "running":
                     state_val = "running"
@@ -364,7 +379,7 @@ class OpenBSDScanService(BaseService):
                 if variable == '' or '=' not in variable:
                     continue
                 else:
-                    k, v = variable.replace(undy, '', 1).split('=')
+                    k, v = variable.replace(undy, '', 1).split('=', 1)
                     info[k] = v
         return info
 

ansible/modules/set_stats.py

@@ -22,7 +22,7 @@ options:
     required: true
   per_host:
     description:
-        - whether the stats are per host or for all hosts in the run.
+        - Whether the stats are per host or for all hosts in the run.
     type: bool
     default: no
   aggregate:

ansible/modules/setup.py

@@ -25,10 +25,10 @@ options:
               V(processor_count), V(python), V(python_version), V(real_user_id), V(selinux), V(service_mgr),
               V(ssh_host_key_dsa_public), V(ssh_host_key_ecdsa_public), V(ssh_host_key_ed25519_public),
               V(ssh_host_key_rsa_public), V(ssh_host_pub_keys), V(ssh_pub_keys), V(system), V(system_capabilities),
-              V(system_capabilities_enforced), V(user), V(user_dir), V(user_gecos), V(user_gid), V(user_id),
+              V(system_capabilities_enforced), V(systemd), V(user), V(user_dir), V(user_gecos), V(user_gid), V(user_id),
               V(user_shell), V(user_uid), V(virtual), V(virtualization_role), V(virtualization_type).
-             Can specify a list of values to specify a larger subset.
-             Values can also be used with an initial C(!) to specify that
+              Can specify a list of values to specify a larger subset.
+              Values can also be used with an initial C(!) to specify that
               that specific subset should not be collected.  For instance:
               V(!hardware,!network,!virtual,!ohai,!facter). If V(!all) is specified
               then only the min subset is collected. To avoid collecting even the

ansible/modules/stat.py

@@ -11,7 +11,7 @@ module: stat
 version_added: "1.3"
 short_description: Retrieve file or file system status
 description:
-     - Retrieves facts for a file similar to the Linux/Unix 'stat' command.
+     - Retrieves facts for a file similar to the Linux/Unix C(stat) command.
      - For Windows targets, use the M(ansible.windows.win_stat) module instead.
 options:
   path:
@@ -44,8 +44,8 @@ options:
     version_added: "2.0"
   get_mime:
     description:
-      - Use file magic and return data about the nature of the file. this uses
-        the 'file' utility found on most Linux/Unix systems.
+      - Use file magic and return data about the nature of the file. This uses
+        the C(file) utility found on most Linux/Unix systems.
       - This will add both RV(stat.mimetype) and RV(stat.charset) fields to the return, if possible.
       - In Ansible 2.3 this option changed from O(mime) to O(get_mime) and the default changed to V(true).
     type: bool

ansible/modules/subversion.py

@@ -42,7 +42,7 @@ options:
   in_place:
     description:
       - If the directory exists, then the working copy will be checked-out over-the-top using
-        svn checkout --force; if force is specified then existing files with different content are reverted.
+        C(svn checkout --force); if force is specified then existing files with different content are reverted.
     type: bool
     default: "no"
     version_added: "2.6"