Misc typo fixes (#66120)

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

changelogs/fragments/misc_typo_fix.yml

@@ -0,0 +1,2 @@
+bugfixes:
+- Misc typo fixes in various documentation pages.

lib/ansible/errors/__init__.py

@@ -230,7 +230,7 @@ class AnsibleCallbackError(AnsibleRuntimeError):
 
 
 class AnsibleTemplateError(AnsibleRuntimeError):
-    '''A template related errror'''
+    '''A template related error'''
     pass
 
 

lib/ansible/modules/cloud/docker/docker_login.py

@@ -169,7 +169,7 @@ if HAS_DOCKER_PY:
             from dockerpycreds.errors import StoreError, CredentialsNotFound
             from dockerpycreds.store import Store
         except ImportError as exc:
-            HAS_DOCKER_ERRROR = str(exc)
+            HAS_DOCKER_ERROR = str(exc)
             NEEDS_DOCKER_PYCREDS = True
 
 

lib/ansible/modules/system/user.py

@@ -206,7 +206,7 @@ options:
     local:
         description:
             - Forces the use of "local" command alternatives on platforms that implement it.
-            - This is useful in environments that use centralized authentification when you want to manipulate the local users
+            - This is useful in environments that use centralized authentication when you want to manipulate the local users
               (i.e. it uses C(luseradd) instead of C(useradd)).
             - This will check C(/etc/passwd) for an existing account before invoking commands. If the local account database
               exists somewhere other than C(/etc/passwd), this setting will not work properly.

lib/ansible/modules/utilities/logic/set_fact.py

@@ -36,7 +36,7 @@ options:
       - This boolean converts the variable into an actual 'fact' which will also be added to the fact cache, if fact caching is enabled.
       - Normally this module creates 'host level variables' and has much higher precedence, this option changes the nature and precedence
         (by 7 steps) of the variable created.
-        https://docs.ansible.com/ansible/latest/user_guide/playbooks_variables.html#variable-precedence-where-should-i-put-a-variable
+        U(https://docs.ansible.com/ansible/latest/user_guide/playbooks_variables.html#variable-precedence-where-should-i-put-a-variable)
       - "This actually creates 2 copies of the variable, a normal 'set_fact' host variable with high precedence and
         a lower 'ansible_fact' one that is available for persistance via the facts cache plugin.
         This creates a possibly confusing interaction with C(meta: clear_facts) as it will remove the 'ansible_fact' but not the host variable."

lib/ansible/plugins/action/nxos_file_copy.py

@@ -328,11 +328,11 @@ class ActionModule(ActionBase):
                 # The before property will contain all text up to the expected string pattern.
                 # The after string will contain the text that was matched by the expected pattern.
                 outcome['expect_timeout'] = True
-                outcome['error_data'] = 'Expect Timeout error occured: BEFORE {0} AFTER {1}'.format(session.before, session.after)
+                outcome['error_data'] = 'Expect Timeout error occurred: BEFORE {0} AFTER {1}'.format(session.before, session.after)
                 return outcome
             else:
                 outcome['error'] = True
-                outcome['error_data'] = 'Unrecognized error occured: BEFORE {0} AFTER {1}'.format(session.before, session.after)
+                outcome['error_data'] = 'Unrecognized error occurred: BEFORE {0} AFTER {1}'.format(session.before, session.after)
                 return outcome
 
             return outcome

lib/ansible/plugins/action/synchronize.py

@@ -272,7 +272,7 @@ class ActionModule(ActionBase):
             # Create a connection to localhost to run rsync on
             new_stdin = self._connection._new_stdin
 
-            # Unike port, there can be only one shell
+            # Unlike port, there can be only one shell
             localhost_shell = None
             for host in C.LOCALHOST:
                 localhost_vars = task_vars['hostvars'].get(host, {})
@@ -286,7 +286,7 @@ class ActionModule(ActionBase):
                 localhost_shell = os.path.basename(C.DEFAULT_EXECUTABLE)
             self._play_context.shell = localhost_shell
 
-            # Unike port, there can be only one executable
+            # Unlike port, there can be only one executable
             localhost_executable = None
             for host in C.LOCALHOST:
                 localhost_vars = task_vars['hostvars'].get(host, {})

lib/ansible/plugins/callback/dense.py

@@ -17,7 +17,7 @@ author:
 - Dag Wieers (@dagwieers)
 version_added: "2.3"
 requirements:
-- set as stdout in configuation
+- set as stdout in configuration
 '''
 
 HAS_OD = False
@@ -229,7 +229,7 @@ class CallbackModule_dense(CallbackModule_default):
                 self._display_results(result, status)
 
     def _clean_results(self, result):
-        # Remove non-essential atributes
+        # Remove non-essential attributes
         for attr in self.removed_attributes:
             if attr in result:
                 del(result[attr])

lib/ansible/plugins/callback/full_skip.py

@@ -11,7 +11,7 @@ DOCUMENTATION = '''
     type: stdout
     short_description: suppresses tasks if all hosts skipped
     description:
-      - Use this plugin when you dont care about any output for tasks that were completly skipped
+      - Use this plugin when you do not care about any output for tasks that were completely skipped
     version_added: "2.4"
     deprecated:
         why: The 'default' callback plugin now supports this functionality
@@ -20,7 +20,7 @@ DOCUMENTATION = '''
     extends_documentation_fragment:
       - default_callback
     requirements:
-      - set as stdout in configuation
+      - set as stdout in configuration
 '''
 
 from ansible.plugins.callback.default import CallbackModule as CallbackModule_default

lib/ansible/plugins/connection/ssh.py

@@ -249,7 +249,7 @@ DOCUMENTATION = '''
       scp_if_ssh:
         default: smart
         description:
-          - "Prefered method to use when transfering files over ssh"
+          - "Preferred method to use when transfering files over ssh"
           - When set to smart, Ansible will try them until one succeeds or they all fail
           - If set to True, it will force 'scp', if False it will use 'sftp'
         env: [{name: ANSIBLE_SCP_IF_SSH}]
@@ -354,7 +354,7 @@ def _handle_error(remaining_retries, command, return_tuple, no_log, host, displa
                 msg = '{0} {1}'.format(msg, to_native(return_tuple[2]).rstrip())
             raise AnsibleConnectionFailure(msg)
 
-    # For other errors, no execption is raised so the connection is retried and we only log the messages
+    # For other errors, no exception is raised so the connection is retried and we only log the messages
     if 1 <= return_tuple[0] <= 254:
         msg = u"Failed to connect to the host via ssh:"
         if no_log:

lib/ansible/plugins/inventory/azure_rm.py

@@ -89,7 +89,7 @@ EXAMPLES = '''
 # The following host variables are always available:
 # public_ipv4_addresses: all public IP addresses, with the primary IP config from the primary NIC first
 # public_dns_hostnames: all public DNS hostnames, with the primary IP config from the primary NIC first
-# private_ipv4_addresses: all private IP addressses, with the primary IP config from the primary NIC first
+# private_ipv4_addresses: all private IP addresses, with the primary IP config from the primary NIC first
 # id: the VM's Azure resource ID, eg /subscriptions/00000000-0000-0000-1111-1111aaaabb/resourceGroups/my_rg/providers/Microsoft.Compute/virtualMachines/my_vm
 # location: the VM's Azure location, eg 'westus', 'eastus'
 # name: the VM's resource name, eg 'myvm'

lib/ansible/vars/manager.py

@@ -229,7 +229,7 @@ class VariableManager:
                             raise AnsibleError("Invalid vars plugin %s from %s" % (plugin._load_name, plugin._original_path))
                 return data
 
-            # internal fuctions that actually do the work
+            # internal functions that actually do the work
             def _plugins_inventory(entities):
                 ''' merges all entities by inventory source '''
                 return get_vars_from_inventory_sources(self._loader, self._inventory._sources, entities, stage)
@@ -241,7 +241,7 @@ class VariableManager:
                     data = combine_vars(data, get_vars_from_path(self._loader, path, entities, stage))
                 return data
 
-            # configurable functions that are sortable via config, rememer to add to _ALLOWED if expanding this list
+            # configurable functions that are sortable via config, remember to add to _ALLOWED if expanding this list
             def all_inventory():
                 return all_group.get_vars()
 
@@ -480,7 +480,7 @@ class VariableManager:
                 # however this would take work in the templating engine, so for now we'll add both
                 variables['play_hosts'] = variables['ansible_play_batch']
 
-        # the 'omit' value alows params to be left out if the variable they are based on is undefined
+        # the 'omit' value allows params to be left out if the variable they are based on is undefined
         variables['omit'] = self._omit_token
         # Set options vars
         for option, option_value in iteritems(self._options_vars):

test/integration/targets/special_vars/tasks/main.yml

@@ -16,7 +16,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
 
-- name: veryfiy ansible_managed
+- name: verify ansible_managed
   template: src=foo.j2 dest={{output_dir}}/special_vars.yaml
 
 - name: read the file into facts