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

Formatting fixes for the module.run changes

Browse Source 
This fixes the RST formatting so that it renders properly in the
bulleted list format. It also makes some changes to the wording for
clarification purposes.
This commit is contained in:
Erik Johnson 2017-04-07 10:00:48 -05:00
parent 3bbebd7d82
commit c36c9465e6
1 changed files with 36 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/topics/releases/nitrogen.rst
View File

@ -61,14 +61,12 @@ State Module Changes
start/stop the service using the ``--no-block`` flag in the ``systemctl`` start/stop the service using the ``--no-block`` flag in the ``systemctl``
command. On non-systemd minions, a warning will be issued. command. On non-systemd minions, a warning will be issued.
- The :py:func:`module.run <salt.states.module.run>` state has dropped its previous - The :py:func:`module.run <salt.states.module.run>` state has dropped its
syntax with ``m_`` prefix for reserved keywords. Additionally, it allows previous syntax with ``m_`` prefix for reserved keywords. Additionally, it
running several functions in a batch. allows running several functions in a batch.
.. note:: .. note::
It is nesessary to explicitly turn on the new behaviour (see below) It is necessary to explicitly turn on the new behavior (see below)
Before and after:
.. code-block:: yaml .. code-block:: yaml
@ -92,11 +90,16 @@ State Module Changes
- second_arg: two - second_arg: two
- do_stuff: True - do_stuff: True
- Previous behaviour of the function :py:func:`module.run <salt.states.module.run>` is
still kept by default and can be bypassed in case you want to use behaviour above.
Please keep in mind that the old syntax will no longer be supported in the ``Oxygen``
release of Salt. To enable the new behavior, add the following to the minion config file:
Since a lot of users are already using :py:func:`module.run
<salt.states.module.run>` states, this new behavior must currently be
explicitly turned on, to allow users to take their time updating their SLS
files. However, please keep in mind that the new syntax will take effect in
the next feature release of Salt (Oxygen) and the old usage will no longer be
supported at that time.
To enable the new behavior for :py:func:`module.run <salt.states.module.run>`,
add the following to the minion config file:
.. code-block:: yaml .. code-block:: yaml
@ -104,7 +107,6 @@ State Module Changes
- module.run - module.run
Execution Module Changes Execution Module Changes
======================== ========================