valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-07 08:58:59 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Remove cmd.wait deprecation reference in docs

Browse Source 
There is a note about deprecating cmd.wait in the docs of the cmd state.
However, this function has not been put on an official deprecation path
and there are no plans to deprecate it. Therefore, we shouldn't have
this note in the docs.

See #44831 for more information.
This commit is contained in:
rallytime 2018-03-05 14:33:45 -05:00
parent a8f2f1b063
commit 90771da999
No known key found for this signature in database
GPG Key ID: E8F1A4B90D0DEA19
1 changed files with 1 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
salt/states/cmd.py
View File

@ -199,8 +199,7 @@ executed when the state it is watching changes. Example:
``cmd.wait`` itself does not do anything; all functionality is inside its ``mod_watch``
function, which is called by ``watch`` on changes.
``cmd.wait`` will be deprecated in future due to the confusion it causes. The
preferred format is using the :ref:`onchanges Requisite <requisites-onchanges>`, which
The preferred format is using the :ref:`onchanges Requisite <requisites-onchanges>`, which
works on ``cmd.run`` as well as on any other state. The example would then look as follows:
.. code-block:: yaml