From 7209fd5c89759050bf8d6abb0db648010ee4dfea Mon Sep 17 00:00:00 2001 From: Jerry Jones gajone3 Date: Wed, 6 Jul 2022 14:25:47 -0400 Subject: [PATCH] typo fixes --- conf/master | 2 +- conf/suse/master | 2 +- doc/topics/cloud/azure.rst | 2 +- doc/topics/cloud/windows.rst | 2 +- doc/topics/community/index.rst | 2 +- doc/topics/development/conventions/documentation.rst | 2 +- doc/topics/development/conventions/formulas.rst | 2 +- doc/topics/development/conventions/release.rst | 2 +- doc/topics/development/reporting_bugs.rst | 2 +- doc/topics/jinja/index.rst | 8 ++++---- doc/topics/pillar/index.rst | 4 ++-- doc/topics/proxyminion/demo.rst | 2 +- doc/topics/proxyminion/ssh.rst | 2 +- doc/topics/reactor/index.rst | 2 +- doc/topics/solaris/solaris-specific-behavior.rst | 2 +- doc/topics/ssh/ssh_ext_alternatives.rst | 6 +++--- doc/topics/tutorials/intro_scale.rst | 2 +- salt/cloud/clouds/libvirt.py | 2 +- salt/config/__init__.py | 8 ++++---- salt/modules/boto_vpc.py | 2 +- 20 files changed, 29 insertions(+), 29 deletions(-) diff --git a/conf/master b/conf/master index 17b3768267e..6209d97270c 100644 --- a/conf/master +++ b/conf/master @@ -51,7 +51,7 @@ # Key cache. Increases master speed for large numbers of accepted # keys. Available options: 'sched'. (Updates on a fixed schedule.) # Note that enabling this feature means that minions will not be -# available to target for up to the length of the maintanence loop +# available to target for up to the length of the maintenance loop # which by default is 60s. #key_cache: '' diff --git a/conf/suse/master b/conf/suse/master index 1262348a308..5dd1f717263 100644 --- a/conf/suse/master +++ b/conf/suse/master @@ -49,7 +49,7 @@ syndic_user: salt # Key cache. Increases master speed for large numbers of accepted # keys. Available options: 'sched'. (Updates on a fixed schedule.) # Note that enabling this feature means that minions will not be -# available to target for up to the length of the maintanence loop +# available to target for up to the length of the maintenance loop # which by default is 60s. #key_cache: '' diff --git a/doc/topics/cloud/azure.rst b/doc/topics/cloud/azure.rst index be9722510de..24598dec2e6 100644 --- a/doc/topics/cloud/azure.rst +++ b/doc/topics/cloud/azure.rst @@ -1102,7 +1102,7 @@ Name of existing container. signed_identifiers `````````````````` -SignedIdentifers instance +SignedIdentifiers instance blob_public_access `````````````````` diff --git a/doc/topics/cloud/windows.rst b/doc/topics/cloud/windows.rst index 45f949a7198..9dfdde6db58 100644 --- a/doc/topics/cloud/windows.rst +++ b/doc/topics/cloud/windows.rst @@ -13,7 +13,7 @@ Requirements .. note:: Support ``winexe`` and ``impacket`` has been deprecated and will be removed in 3001. These dependencies are replaced by ``pypsexec`` and ``smbprotocol`` - respectivly. These are pure python alternatives that are compatible with all + respectively. These are pure python alternatives that are compatible with all supported python versions. Salt Cloud makes use of `impacket` and `winexe` to set up the Windows Salt diff --git a/doc/topics/community/index.rst b/doc/topics/community/index.rst index 956ccb4149e..38559c1c31a 100644 --- a/doc/topics/community/index.rst +++ b/doc/topics/community/index.rst @@ -20,7 +20,7 @@ is hosted by Google Groups. It is open to new members. .. _`salt-users mailing list`: https://groups.google.com/forum/#!forum/salt-users Additionally, all users of Salt should be subscribed to the Announcements mailing -list which contains important updates about Salt, such as new releaes and +list which contains important updates about Salt, such as new releases and security-related announcements. This list is low-traffic. .. _`salt-announce mailing list`: https://groups.google.com/forum/#!forum/salt-announce diff --git a/doc/topics/development/conventions/documentation.rst b/doc/topics/development/conventions/documentation.rst index 66063cf01c3..dc04f0cd787 100644 --- a/doc/topics/development/conventions/documentation.rst +++ b/doc/topics/development/conventions/documentation.rst @@ -160,7 +160,7 @@ New modules must be added to the index manually. :blob:`state modules`, :blob:`renderer modules `, etc. -2. Add the new module to the alphebetized list. +2. Add the new module to the alphabetized list. 3. :ref:`Build the documentation ` which will generate an ``.rst`` file for the new module in the same directory as the ``index.rst``. diff --git a/doc/topics/development/conventions/formulas.rst b/doc/topics/development/conventions/formulas.rst index 3e9046da276..ad9033b2d10 100644 --- a/doc/topics/development/conventions/formulas.rst +++ b/doc/topics/development/conventions/formulas.rst @@ -598,7 +598,7 @@ Avoid heavy logic and programming ````````````````````````````````` Jinja is not Python. It was made by Python programmers and shares many -semantics and some syntax but it does not allow for abitrary Python function +semantics and some syntax but it does not allow for arbitrary Python function calls or Python imports. Jinja is a fast and efficient templating language but the syntax can be verbose and visually noisy. diff --git a/doc/topics/development/conventions/release.rst b/doc/topics/development/conventions/release.rst index 51630aaf025..fc414fb0116 100644 --- a/doc/topics/development/conventions/release.rst +++ b/doc/topics/development/conventions/release.rst @@ -32,7 +32,7 @@ example): #. Announce new RC to salt-users and salt-announce google groups. #. Triage incoming issues based on the new RC release. #. Fix RC issues once they are categorized as a release blocker. -#. Depending on the issues found during the RC process make a decesion +#. Depending on the issues found during the RC process make a decision on whether to release based off the RC or go through another RC process #. If a RC is categorized as stable, build all required packages. #. Test all release packages. diff --git a/doc/topics/development/reporting_bugs.rst b/doc/topics/development/reporting_bugs.rst index 8ea43d9eb86..73c2af61c57 100644 --- a/doc/topics/development/reporting_bugs.rst +++ b/doc/topics/development/reporting_bugs.rst @@ -23,7 +23,7 @@ In an issue report, please include the following information: * Any configuration options set in a configuration file that may be relevant. - * A reproduceable test case. This may be as simple as an SLS file that + * A reproducible test case. This may be as simple as an SLS file that illustrates a problem or it may be a link to a repository that contains a number of SLS files that can be used together to re-produce a problem. If the problem is transitory, any information that can be used to try and diff --git a/doc/topics/jinja/index.rst b/doc/topics/jinja/index.rst index 6a706858900..85a6800d6cd 100644 --- a/doc/topics/jinja/index.rst +++ b/doc/topics/jinja/index.rst @@ -1144,7 +1144,7 @@ Example: This option may have adverse effects when using the default renderer, ``jinja|yaml``. This is due to the fact that YAML requires proper handling in regard to special characters. Please see the section on :ref:`YAML ASCII - support ` in the :ref:`YAML Idiosyncracies + support ` in the :ref:`YAML Idiosyncrasies ` documentation for more information. .. jinja_ref:: json_decode_list @@ -1988,7 +1988,7 @@ Example: This option may have adverse effects when using the default renderer, ``jinja|yaml``. This is due to the fact that YAML requires proper handling in regard to special characters. Please see the section on :ref:`YAML ASCII - support ` in the :ref:`YAML Idiosyncracies + support ` in the :ref:`YAML Idiosyncrasies ` documentation for more information. .. jinja_ref:: dns_check @@ -2366,8 +2366,8 @@ external template file. .. note:: - Macros and variables can be shared across templates. They should not be - starting with one or more underscores, and should be managed by one of the + Macros and variables can be shared across templates. They should not start + with one or more underscores, and should be managed by one of the following tags: `macro`, `set`, `load_yaml`, `load_json`, `import_yaml` and `import_json`. diff --git a/doc/topics/pillar/index.rst b/doc/topics/pillar/index.rst index 7e88cd17a53..66e49c091a3 100644 --- a/doc/topics/pillar/index.rst +++ b/doc/topics/pillar/index.rst @@ -522,7 +522,7 @@ The :py:func:`pillar.get ` Function The :mod:`pillar.get ` function works much in the same way as the ``get`` method in a python dict, but with an enhancement: nested -dictonaries can be traversed using a colon as a delimiter. +dictionaries can be traversed using a colon as a delimiter. If a structure like this is in pillar: @@ -706,7 +706,7 @@ The following functions support passing pillar data on the CLI via the - :py:func:`state.highstate ` - :py:func:`state.sls ` -Triggerring decryption of this CLI pillar data can be done in one of two ways: +Triggering decryption of this CLI pillar data can be done in one of two ways: 1. Using the ``pillar_enc`` argument: diff --git a/doc/topics/proxyminion/demo.rst b/doc/topics/proxyminion/demo.rst index b8ffa1c41d9..4ad27de1df6 100644 --- a/doc/topics/proxyminion/demo.rst +++ b/doc/topics/proxyminion/demo.rst @@ -100,7 +100,7 @@ the 'url' key above should say ``url: http://127.0.0.1:8000`` 8. The REST service implements a degenerately simple pkg and service provider as well as a small set of grains. To "install" a package, use a standard - ``pkg.install``. If you pass '==' and a verrsion number after the package + ``pkg.install``. If you pass '==' and a version number after the package name then the service will parse that and accept that as the package's version. diff --git a/doc/topics/proxyminion/ssh.rst b/doc/topics/proxyminion/ssh.rst index f9d180b4709..f18e87d563f 100644 --- a/doc/topics/proxyminion/ssh.rst +++ b/doc/topics/proxyminion/ssh.rst @@ -76,6 +76,6 @@ from the file ``/srv/pillar/p8000.sls`` (if you have not changed your default pi 8. The SSH shell implements a degenerately simple pkg. To "install" a package, use a standard - ``pkg.install``. If you pass '==' and a verrsion number after the package + ``pkg.install``. If you pass '==' and a version number after the package name then the service will parse that and accept that as the package's version. diff --git a/doc/topics/reactor/index.rst b/doc/topics/reactor/index.rst index 740f330f091..ba467f63d7b 100644 --- a/doc/topics/reactor/index.rst +++ b/doc/topics/reactor/index.rst @@ -99,7 +99,7 @@ API and the runner system. In this example, a command is published to the - mods: orchestrate.runit {% endif %} -This example will execute the state.orchestrate runner and intiate an execution +This example will execute the state.orchestrate runner and initiate an execution of the ``runit`` orchestrator located at ``/srv/salt/orchestrate/runit.sls``. Types of Reactions diff --git a/doc/topics/solaris/solaris-specific-behavior.rst b/doc/topics/solaris/solaris-specific-behavior.rst index b8d63206d18..7febed84540 100644 --- a/doc/topics/solaris/solaris-specific-behavior.rst +++ b/doc/topics/solaris/solaris-specific-behavior.rst @@ -19,7 +19,7 @@ issue on github: #37027 Grains ========================= Not all grains are available or some have empty or 0 as value. Mostly grains -that are depenend on hardware discovery like: +that are dependent on hardware discovery like: - num_gpus - gpus diff --git a/doc/topics/ssh/ssh_ext_alternatives.rst b/doc/topics/ssh/ssh_ext_alternatives.rst index 11c0342da68..fc2a1234f40 100644 --- a/doc/topics/ssh/ssh_ext_alternatives.rst +++ b/doc/topics/ssh/ssh_ext_alternatives.rst @@ -8,7 +8,7 @@ In the 2019.2.0 release the ``ssh_ext_alternatives`` feature was added. This allows salt-ssh to work across different supported python versions. You will need to ensure you have the following: - - Salt is installed, with all required dependnecies for the Python version. + - Salt is installed, with all required dependencies for the Python version. - Everything needs to be importable from the respective Python environment. To enable using this feature you will need to edit the master configuration similar @@ -56,7 +56,7 @@ does not require you to define them under ``dependencies``. py_bin: /usr/bin/python2.7 # Python binary path used to auto detect dependencies If ``py_bin`` is not set alongside ``auto_detect``, it will attempt to auto detect -the dependnecies using the major version set in ``py-version``. For example if you +the dependencies using the major version set in ``py-version``. For example if you have ``[2, 7]`` set as your ``py-version``, it will attempt to use the binary ``python2``. You can also use ``auto_detect`` and ``dependencies`` together. @@ -72,7 +72,7 @@ You can also use ``auto_detect`` and ``dependencies`` together. dependencies: # List of dependencies and their installation paths jinja2: /opt/jinja2 -If a dependency is defined in the ``dependecies`` list ``ssh_ext_alternatives`` will use +If a dependency is defined in the ``dependencies`` list ``ssh_ext_alternatives`` will use this dependency, instead of the path that ``auto_detect`` finds. For example, if you define ``/opt/jinja2`` under your ``dependencies`` for jinja2, it will not try to autodetect the file path to the jinja2 module, and will favor ``/opt/jinja2``. diff --git a/doc/topics/tutorials/intro_scale.rst b/doc/topics/tutorials/intro_scale.rst index 9ddee19f5cb..123123e5665 100644 --- a/doc/topics/tutorials/intro_scale.rst +++ b/doc/topics/tutorials/intro_scale.rst @@ -282,7 +282,7 @@ that information back to the waiting client before the job can be published. To mitigate this, a key cache may be enabled. This will reduce the load on the master to a single file open instead of thousands or tens of thousands. -This cache is updated by the maintanence process, however, which means that +This cache is updated by the maintenance process, however, which means that minions with keys that are accepted may not be targeted by the master for up to sixty seconds by default. diff --git a/salt/cloud/clouds/libvirt.py b/salt/cloud/clouds/libvirt.py index 22a79abbc84..76f6f6daa26 100644 --- a/salt/cloud/clouds/libvirt.py +++ b/salt/cloud/clouds/libvirt.py @@ -538,7 +538,7 @@ def do_cleanup(cleanup): behavior over time. Passed in volumes and domains are deleted, any errors are ignored. Used when cloning/provisioning a domain fails. - :param cleanup: list containing dictonaries with two keys: 'what' and 'item'. + :param cleanup: list containing dictionaries with two keys: 'what' and 'item'. If 'what' is domain the 'item' is a libvirt domain object. If 'what' is volume then the item is a libvirt volume object. diff --git a/salt/config/__init__.py b/salt/config/__init__.py index a1a3e1523c3..48ace8d6dff 100644 --- a/salt/config/__init__.py +++ b/salt/config/__init__.py @@ -119,7 +119,7 @@ VALID_OPTS = immutabletypes.freeze( "master_uri_format": str, # The following options refer to the Minion only, and they specify # the details of the source address / port to be used when connecting to - # the Master. This is useful when dealing withmachines where due to firewall + # the Master. This is useful when dealing with machines where due to firewall # rules you are restricted to use a certain IP/port combination only. "source_interface_name": str, "source_address": str, @@ -131,7 +131,7 @@ VALID_OPTS = immutabletypes.freeze( # Deprecated in 2019.2.0. Use 'random_master' instead. # Do not remove! Keep as an alias for usability. "master_shuffle": bool, - # When in multi-master mode, temporarily remove a master from the list if a conenction + # When in multi-master mode, temporarily remove a master from the list if a connection # is interrupted and try another master in the list. "master_alive_interval": int, # When in multi-master failover mode, fail back to the first master in the list if it's back @@ -165,7 +165,7 @@ VALID_OPTS = immutabletypes.freeze( "syndic_finger": str, # The caching mechanism to use for the PKI key store. Can substantially decrease master publish # times. Available types: - # 'maint': Runs on a schedule as a part of the maintanence process. + # 'maint': Runs on a schedule as a part of the maintenance process. # '': Disable the key cache [default] "key_cache": str, # The user under which the daemon should run @@ -208,7 +208,7 @@ VALID_OPTS = immutabletypes.freeze( "renderer": str, # Renderer whitelist. The only renderers from this list are allowed. "renderer_whitelist": list, - # Rendrerer blacklist. Renderers from this list are disalloed even if specified in whitelist. + # Renderer blacklist. Renderers from this list are disallowed even if specified in whitelist. "renderer_blacklist": list, # A flag indicating that a highstate run should immediately cease if a failure occurs. "failhard": bool, diff --git a/salt/modules/boto_vpc.py b/salt/modules/boto_vpc.py index 6c400e7809e..ee7a757e2b2 100644 --- a/salt/modules/boto_vpc.py +++ b/salt/modules/boto_vpc.py @@ -1822,7 +1822,7 @@ def delete_nat_gateway( nat_gateway_id Id of the NAT Gateway - releaes_eips + release_eips whether to release the elastic IPs associated with the given NAT Gateway Id region