Update documentation on "refresh" behavior in pkg states (#34100)

This commit is contained in:
Erik Johnson 2016-06-17 17:42:35 -05:00 committed by Nicole Thomas
parent 6d0d52fa86
commit 79a719b719

View file

@ -683,8 +683,22 @@ def installed(
- salt-minion: 2015.8.5-1.el6
:param bool refresh:
Update the repo database of available packages prior to installing the
requested package.
This parameter controls whether or not the packge repo database is
updated prior to installing the requested package(s).
If ``True``, the package database will be refreshed (``apt-get
update`` or equivalent, depending on platform) before installing.
If ``False``, the package database will *not* be refreshed before
installing.
If unset, then Salt treats package database refreshes differently
depending on whether or not a ``pkg`` state has been executed already
during the current Salt run. Once a refresh has been performed in a
``pkg`` state, for the remainder of that Salt run no other refreshes
will be performed for ``pkg`` states which do not explicitly set
``refresh`` to ``True``. This prevents needless additional refreshes
from slowing down the Salt run.
:param str fromrepo:
Specify a repository from which to install
@ -1419,8 +1433,24 @@ def latest(
Skip the GPG verification check for the package to be installed
refresh
Update the repo database of available packages prior to installing the
requested package.
This parameter controls whether or not the packge repo database is
updated prior to checking for the latest available version of the
requested packages.
If ``True``, the package database will be refreshed (``apt-get update``
or equivalent, depending on platform) before checking for the latest
available version of the requested packages.
If ``False``, the package database will *not* be refreshed before
checking.
If unset, then Salt treats package database refreshes differently
depending on whether or not a ``pkg`` state has been executed already
during the current Salt run. Once a refresh has been performed in a
``pkg`` state, for the remainder of that Salt run no other refreshes
will be performed for ``pkg`` states which do not explicitly set
``refresh`` to ``True``. This prevents needless additional refreshes
from slowing down the Salt run.
Multiple Package Installation Options: