Fix spelling mistakes (comments only) (ansible#25564)

Original Author : klemens <[email protected]>

Taking over previous PR as per
ansible#23644 (comment)

Signed-off-by: Abhijeet Kasurde <[email protected]>

Author: Akasurde

CHANGELOG.md

@@ -1195,7 +1195,7 @@ Module fixes:
   running rsync.  In 1.9.x and previous, sudo was run on the host that rsync
   connected to.  2.0.1 restores the 1.9.x behaviour.
 * Additionally, several other problems with where synchronize chose to run when
-  combined with delegate_to were fixed.  In particular, if a playbook targetted
+  combined with delegate_to were fixed.  In particular, if a playbook targeted
   localhost and then delegated_to a remote host the prior behavior (in 1.9.x
   and 2.0.0.x) was to copy files between the src and destination directories on
   the delegated host.  This has now been fixed to copy between localhost and
@@ -2728,7 +2728,7 @@ the variable is still registered for the host, with the attribute skipped: True.
 * added basename and dirname as Jinja2 filters available to all templates
 * pip works better when sudoing from unprivileged users
 * fix for user creation with groups specification reporting 'changed' incorrectly in some cases
-* fix for some unicode encoding errors in outputing some data in verbose mode
+* fix for some unicode encoding errors in outputting some data in verbose mode
 * improved FreeBSD, NetBSD and Solaris facts
 * debug module always outputs data without having to specify -v
 * fix for sysctl module creating new keys (must specify checks=none)
@@ -3102,7 +3102,7 @@ New Modules:
 * new LSB facts (release, distro, etc)
 * pause module -- (pause seconds=10) (pause minutes=1) (pause prompt=foo) -- it's an action plugin
 * a module for adding entries to the main crontab (though you may still wish to just drop template files into cron.d)
-* debug module can be used for outputing messages without using 'shell echo'
+* debug module can be used for outputting messages without using 'shell echo'
 * a fail module is now available for causing errors, you might want to use it with only_if to fail in certain conditions
 
 Other module Changes, Upgrades, and Fixes:

contrib/inventory/apstra_aos.py

@@ -27,7 +27,7 @@
 
 To use this:
  - copy this file over /etc/ansible/hosts and chmod +x the file.
- - Copy both files (.py and .ini) in your prefered directory
+ - Copy both files (.py and .ini) in your preferred directory
 
 More information about Ansible Dynamic Inventory here
 http://unix.stackexchange.com/questions/205479/in-ansible-dynamic-inventory-json-can-i-render-hostvars-based-on-the-hostname

contrib/inventory/ec2.py

@@ -12,7 +12,7 @@
     export AWS_ACCESS_KEY_ID='AK123'
     export AWS_SECRET_ACCESS_KEY='abc123'
 
-optional region environement variable if region is 'auto'
+optional region environment variable if region is 'auto'
 
 This script also assumes there is an ec2.ini file alongside it.  To specify a
 different path to ec2.ini, define the EC2_INI_PATH environment variable:
@@ -723,7 +723,7 @@ def get_elasticache_clusters_by_region(self, region):
         ''' Makes an AWS API call to the list of ElastiCache clusters (with
         nodes' info) in a particular region.'''
 
-        # ElastiCache boto module doesn't provide a get_all_intances method,
+        # ElastiCache boto module doesn't provide a get_all_instances method,
         # that's why we need to call describe directly (it would be called by
         # the shorthand method anyway...)
         try:
@@ -759,7 +759,7 @@ def get_elasticache_replication_groups_by_region(self, region):
         ''' Makes an AWS API call to the list of ElastiCache replication groups
         in a particular region.'''
 
-        # ElastiCache boto module doesn't provide a get_all_intances method,
+        # ElastiCache boto module doesn't provide a get_all_instances method,
         # that's why we need to call describe directly (it would be called by
         # the shorthand method anyway...)
         try:

contrib/inventory/nagios_livestatus.ini

@@ -19,7 +19,7 @@
 # default field group for host: groups
 # Uncomment to override:
 # group_field=state
-# default fields retrieved: address, alias, display_name, childs, parents
+# default fields retrieved: address, alias, display_name, children, parents
 # To override, uncomment the following line
 # fields_to_retrieve=address,alias,display_name
 #

docs/bin/generate_man.py

@@ -94,7 +94,7 @@ def opts_docs(cli, name):
             myclass = "%sCLI" % libname.capitalize()
             output[libname] = 'ansible-%s.1.asciidoc.in' % libname
 
-        # instanciate each cli and ask its options
+        # instantiate each cli and ask its options
         mycli = getattr(__import__("ansible.cli.%s" % libname, fromlist=[myclass]), myclass)
         cli_object = mycli([])
         try:

docs/docsite/rst/dev_guide/developing_modules_in_groups.rst

@@ -29,6 +29,7 @@ Although it's tempting to get straight into coding, there are a few things to be
 * Although not required, unit and/or integration tests are strongly recommended. Unit tests are especially valuable when external resources (such as cloud or network devices) are required. For more information see :doc:`testing` and the `Testing Working Group <https://github.com/ansible/community/blob/master/MEETINGS.md>`_.
   * Starting with Ansible 2.4 all :doc:`../list_of_network_modules` MUST have unit tests.
 
+
 Naming Convention
 `````````````````
 
@@ -142,7 +143,7 @@ We realise this may be your first use of Git or GitHub. The following guides may
 * `How to sync (update) your fork <https://help.github.com/articles/syncing-a-fork/>`_
 * `How to create a Pull Request (PR) <https://help.github.com/articles/about-pull-requests/>`_
 
-Please note that in the Ansible Git Repo the main branch is called ``devel`` rather than ``master``, which is used in the offical GitHub documentation
+Please note that in the Ansible Git Repo the main branch is called ``devel`` rather than ``master``, which is used in the official GitHub documentation
 
 After your first PR has been merged ensure you "sync your fork" with ``ansible/ansible`` to ensure you've pulled in the directory structure and and shared code or documentation previously created.
 

docs/docsite/rst/intro_networking.rst

@@ -169,9 +169,9 @@ Ansible allows you to use conditionals to control the flow of your playbooks. An
 * contains - Object contains specified item
 
 
-Conditional statements evalute the results from the commands that are
+Conditional statements evaluate the results from the commands that are
 executed remotely on the device.  Once the task executes the command
-set, the waitfor argument can be used to evalute the results before
+set, the waitfor argument can be used to evaluate the results before
 returning control to the Ansible playbook.
 
 For example::

docs/docsite/rst/intro_windows.rst

@@ -55,7 +55,7 @@ At the prompt you can quickly start using the Ansible devel branch by running th
     git clone https://github.com/ansible/ansible.git
     source ansible/hacking/env-setup
 
-After you've successfully run these commands, you can start to create your inventory, write example playbooks and start targetting systems using the plethora of available Windows modules.
+After you've successfully run these commands, you can start to create your inventory, write example playbooks and start targeting systems using the plethora of available Windows modules.
 
 .. Note:: Ansible is also reported to work on Cygwin, but this is more cumbersome and doesn't scale as well as WSL.
 
@@ -469,7 +469,7 @@ You may wind up with a more readable playbook by using the PowerShell equivalent
          - name: Move file on remote Windows Server from one location to another
            win_command: Powershell.exe "Move-Item C:\teststuff\myfile.conf C:\builds\smtp.conf"
 
-Bear in mind that using ``win_command`` or ``win_shell`` will always report ``changed``, and it is your responsiblity to ensure PowerShell will need to handle idempotency as appropriate (the move examples above are inherently not idempotent), so where possible use (or write) a module.
+Bear in mind that using ``win_command`` or ``win_shell`` will always report ``changed``, and it is your responsibility to ensure PowerShell will need to handle idempotency as appropriate (the move examples above are inherently not idempotent), so where possible use (or write) a module.
 
 Here's an example of how to use the ``win_stat`` module to test for file existence. Note that the data returned by the ``win_stat`` module is slightly different than what is provided by the Linux equivalent::
 

docs/docsite/rst/modules_support.rst

@@ -3,7 +3,7 @@ Module Support
 
 .. toctree:: :maxdepth: 1
 
-Ansible has many modules, but not all of them are maintained by the core project commiters. Each module should have associated metadata that indicates which of the following categories they fall into. This should be visible in each module's documentation.
+Ansible has many modules, but not all of them are maintained by the core project committers. Each module should have associated metadata that indicates which of the following categories they fall into. This should be visible in each module's documentation.
 
 Documentation updates for each module can also be edited directly in the module and by submitting a pull request to the module source code; just look for the "DOCUMENTATION" block in the source tree.
 

docs/docsite/rst/playbooks_lookups.rst

@@ -473,7 +473,7 @@ Since there are too many parameters for this lookup method, below is a sample pl
 
           #optional query  parameters
           #we accept any parameter from the normal mongodb query.
-          # the offical documentation is here
+          # the official documentation is here
           # https://api.mongodb.org/python/current/api/pymongo/collection.html?highlight=find#pymongo.collection.Collection.find
           # filter:  { "hostname": "batman" }
           projection: { "pid": True    , "_id" : False , "hostname" : True }

examples/hosts.yaml

@@ -45,7 +45,7 @@
 ##                beta.example.org:
 
 # Ex 4: all vars
-# keeping withing 'all' group you can define common 'all' vars here with lowest precedence
+# keeping within 'all' group you can define common 'all' vars here with lowest precedence
 
 ##  vars:
 ##      commontoall: thisvar

examples/scripts/ConfigureRemotingForAnsible.ps1

@@ -16,7 +16,7 @@
 # a 10-year valid certificate.
 #
 # Use option -ForceNewSSLCert if the system has been SysPreped and a new
-# SSL Certifcate must be forced on the WinRM Listener when re-running this
+# SSL Certificate must be forced on the WinRM Listener when re-running this
 # script. This is necessary when a new SID and CN name is created.
 #
 # Use option -SkipNetworkProfileCheck to skip the network profile check.

hacking/metadata-tool.py

@@ -398,7 +398,7 @@ def write_metadata(filename, new_metadata, version=None, overwrite=False):
         raise ParseError('Could not add metadata to {}'.format(filename))
 
     if current_metadata is None:
-        # No curent metadata so we can just add it
+        # No current metadata so we can just add it
         start_line = find_documentation(module_data)
         if start_line < 0:
             if os.path.basename(filename) in NONMODULE_PY_FILES:

lib/ansible/cli/vault.py

@@ -148,7 +148,7 @@ def run(self):
             self.b_new_vault_pass = CLI.read_vault_password_file(self.options.new_vault_password_file, loader)
 
         if not self.b_vault_pass or self.options.ask_vault_pass:
-            # the 'read' options dont need to ask for password confirmation.
+            # the 'read' options don't need to ask for password confirmation.
             # 'edit' is read/write, but the decrypt will confirm.
             if self.action in ['decrypt', 'edit', 'view', 'rekey']:
                 self.b_vault_pass = self.ask_vault_passwords()
@@ -213,7 +213,7 @@ def execute_encrypt_string(self):
         b_plaintext_list = []
 
         # remove the non-option '-' arg (used to indicate 'read from stdin') from the candidate args so
-        # we dont add it to the plaintext list
+        # we don't add it to the plaintext list
         args = [x for x in self.args if x != '-']
 
         # We can prompt and read input, or read from stdin, but not both.
@@ -298,7 +298,7 @@ def execute_encrypt_string(self):
         # TODO: offer block or string ala eyaml
 
     def _format_output_vault_strings(self, b_plaintext_list):
-        # If we are only showing one item in the output, we dont need to included commented
+        # If we are only showing one item in the output, we don't need to included commented
         # delimiters in the text
         show_delimiter = False
         if len(b_plaintext_list) > 1:

lib/ansible/executor/play_iterator.py

@@ -331,7 +331,7 @@ def _get_next_task_from_state(self, state, host, peek, in_child=False):
 
                 # First, we check for a child task state that is not failed, and if we
                 # have one recurse into it for the next task. If we're done with the child
-                # state, we clear it and drop back to geting the next task from the list.
+                # state, we clear it and drop back to getting the next task from the list.
                 if state.tasks_child_state:
                     (state.tasks_child_state, task) = self._get_next_task_from_state(state.tasks_child_state, host=host, peek=peek, in_child=True)
                     if self._check_failed_state(state.tasks_child_state):

lib/ansible/module_utils/ovirt.py

@@ -550,7 +550,7 @@ def create(
                     )
                     self.post_update(entity)
 
-                # Update diffs only if user specified --diff paramter,
+                # Update diffs only if user specified --diff parameter,
                 # so we don't useless overload API:
                 if self._module._diff:
                     before = get_dict_of_struct(

lib/ansible/module_utils/service.py

@@ -67,7 +67,7 @@ def get_sysv_script(name):
 def sysv_exists(name):
     '''
     This function will return True or False depending on
-    the existance of an init script corresponding to the service name supplied.
+    the existence of an init script corresponding to the service name supplied.
 
     :arg name: name of the service to test for
     '''
@@ -93,7 +93,7 @@ def fail_if_missing(module, found, service, msg=''):
 
 def daemonize(module, cmd):
     '''
-    Execute a command while detaching as a deamon, returns rc, stdout, and stderr.
+    Execute a command while detaching as a daemon, returns rc, stdout, and stderr.
 
     :arg module: is an  AnsbileModule object, used for it's utility methods
     :arg cmd: is a list or string representing the command and options to run

lib/ansible/module_utils/urls.py

@@ -468,7 +468,7 @@ def generic_urlparse(parts):
                 # so remove it and convert the port to an integer
                 port = int(port[1:])
             if auth:
-                # the capture group above inclues the @, so remove it
+                # the capture group above includes the @, so remove it
                 # and then split it up based on the first ':' found
                 auth = auth[:-1]
                 username, password = auth.split(':', 1)

lib/ansible/modules/cloud/amazon/ec2_group.py

@@ -45,7 +45,7 @@
     description:
       - List of firewall inbound rules to enforce in this group (see example). If none are supplied,
         no inbound rules will be enabled. Rules list may include its own name in `group_name`.
-        This allows idempotent loopback additions (e.g. allow group to acccess itself).
+        This allows idempotent loopback additions (e.g. allow group to access itself).
         Rule sources list support was added in version 2.4. This allows to define multiple sources per
         source type as well as multiple source types per rule. Prior to 2.4 an individual source is allowed.
     required: false

lib/ansible/modules/cloud/amazon/ec2_vpc_route_table.py

@@ -30,7 +30,7 @@
   lookup:
     description:
       - "Look up route table by either tags or by route table ID. Non-unique tag lookup will fail.
-        If no tags are specifed then no lookup for an existing route table is performed and a new
+        If no tags are specified then no lookup for an existing route table is performed and a new
         route table will be created. To change tags of a route table or delete a route table,
         you must look up by id."
     required: false

lib/ansible/modules/cloud/amazon/s3.py

@@ -253,7 +253,7 @@
     bucket: mybucket
     mode: delete
 
-- name: GET an object but dont download if the file checksums match. New in 2.0
+- name: GET an object but don't download if the file checksums match. New in 2.0
   s3:
     bucket: mybucket
     object: /my/desired/key.txt

lib/ansible/modules/cloud/amazon/sns.py

@@ -207,7 +207,7 @@ def main():
                              "the 'json' message_structure.")
 
     # .publish() takes full ARN topic id, but I'm lazy and type shortnames
-    # so do a lookup (topics cannot contain ':', so thats the decider)
+    # so do a lookup (topics cannot contain ':', so that's the decider)
     if ':' in topic:
         arn_topic = topic
     else:

lib/ansible/modules/cloud/cloudstack/cs_instance.py

@@ -872,7 +872,7 @@ def expunge_instance(self):
 
     def stop_instance(self):
         instance = self.get_instance()
-        # in check mode intance may not be instanciated
+        # in check mode instance may not be instanciated
         if instance:
             if instance['state'].lower() in ['stopping', 'stopped']:
                 return instance
@@ -893,7 +893,7 @@ def stop_instance(self):
 
     def start_instance(self):
         instance = self.get_instance()
-        # in check mode intance may not be instanciated
+        # in check mode instance may not be instanciated
         if instance:
             if instance['state'].lower() in ['starting', 'running']:
                 return instance
@@ -914,7 +914,7 @@ def start_instance(self):
 
     def restart_instance(self):
         instance = self.get_instance()
-        # in check mode intance may not be instanciated
+        # in check mode instance may not be instanciated
         if instance:
             if instance['state'].lower() in [ 'running', 'starting' ]:
                 self.result['changed'] = True
@@ -936,7 +936,7 @@ def restart_instance(self):
     def restore_instance(self):
         instance = self.get_instance()
         self.result['changed'] = True
-        # in check mode intance may not be instanciated
+        # in check mode instance may not be instanciated
         if instance:
             args = {}
             args['templateid'] = self.get_template_or_iso(key='id')

lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule_member.py

@@ -82,7 +82,7 @@
 '''
 
 EXAMPLES = '''
-# Add VMs to an exising load balancer
+# Add VMs to an existing load balancer
 - local_action:
     module: cs_loadbalancer_rule_member
     name: balance_http

lib/ansible/modules/cloud/cloudstack/cs_pod.py

@@ -38,7 +38,7 @@
     required: true
   id:
     description:
-      - uuid of the exising pod.
+      - uuid of the existing pod.
     default: null
     required: false
   start_ip:

lib/ansible/modules/cloud/cloudstack/cs_vpc.py

@@ -161,7 +161,7 @@
   type: boolean
   sample: true
 restart_required:
-  description: "Wheter the VPC router needs a restart or not."
+  description: "Whether the VPC router needs a restart or not."
   returned: success
   type: boolean
   sample: true

lib/ansible/modules/cloud/cloudstack/cs_zone.py

@@ -38,7 +38,7 @@
     required: true
   id:
     description:
-      - uuid of the exising zone.
+      - uuid of the existing zone.
     default: null
     required: false
   state:

lib/ansible/modules/cloud/google/gcdns_record.py

@@ -56,7 +56,7 @@
             - The DNS domain name of the zone (e.g., example.com).
             - One of either I(zone) or I(zone_id) must be specified as an
               option, or the module will fail.
-            - If both I(zone) and I(zone_id) are specifed, I(zone_id) will be
+            - If both I(zone) and I(zone_id) are specified, I(zone_id) will be
               used.
         required: false
     zone_id:
@@ -68,7 +68,7 @@
               with dashes. A zone ID will never have any dots in it.
             - I(zone_id) can be faster than I(zone) in projects with a large
               number of zones.
-            - If both I(zone) and I(zone_id) are specifed, I(zone_id) will be
+            - If both I(zone) and I(zone_id) are specified, I(zone_id) will be
               used.
         required: false
     type:

lib/ansible/modules/cloud/google/gce.py

@@ -193,7 +193,7 @@
 EXAMPLES = '''
 # Basic provisioning example.  Create a single Debian 8 instance in the
 # us-central1-a Zone of the n1-standard-1 machine type.
-# Create multiple instances by specifying multiple names, seperated by
+# Create multiple instances by specifying multiple names, separated by
 # commas in the instance_names field
 # (e.g. my-test-instance1,my-test-instance2)
     gce:

lib/ansible/modules/cloud/linode/linode.py

@@ -81,7 +81,7 @@
     version_added: "2.3"
   alert_bwquota_enabled:
     description:
-    - Set status of bandwidth quota alerts as percentage of network tranfer quota.
+    - Set status of bandwidth quota alerts as percentage of network transfer quota.
     default: "True"
     choices: [ "True", "False" ]
     version_added: "2.3"

lib/ansible/modules/cloud/openstack/os_auth.py

@@ -34,7 +34,7 @@
 options:
   availability_zone:
     description:
-      - Ignored. Present for backwards compatability
+      - Ignored. Present for backwards compatibility
     required: false
 extends_documentation_fragment: openstack
 '''