saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-16 09:40:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

doc(mab_brew_pkg): Add options parameter documentation

Browse source
This commit is contained in:
Carlos Álvaro 2024-07-17 08:06:40 +02:00 • committed by Daniel Wozniak
parent 8416fe4311
commit 40f871c2b1
1 changed files with 22 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
salt/modules/mac_brew_pkg.py
View file

@ -308,8 +308,10 @@ def latest_version(*names, options=None, **kwargs):
exist.
options
Additional options to pass to brew. Useful to remove ambiguous packages
that can conflict between formulae and casks.
List of string with additional options to pass to brew.
Useful to remove ambiguous packages that can conflict between formulae and casks.
.. versionadded:: 3008.0
CLI Example:
@ -371,8 +373,10 @@ def remove(name=None, pkgs=None, options=None, **kwargs):
``name`` parameter will be ignored if this option is passed.
options
Additional options to pass to brew. Useful to remove ambiguous packages
that can conflict between formulae and casks.
List of string with additional options to pass to brew.
Useful to remove ambiguous packages that can conflict between formulae and casks.
.. versionadded:: 3008.0
.. versionadded:: 0.16.0
@ -454,8 +458,10 @@ def _info(*pkgs, options=None):
object in the output of 'brew info'.
options
Additional options to pass to brew. Useful to remove ambiguous packages
that can conflict between formulae and casks.
List of string with additional options to pass to brew.
Useful to remove ambiguous packages that can conflict between formulae and casks.
.. versionadded:: 3008.0
Caveat: If one of the packages does not exist, no packages will be
included in the output.
@ -618,7 +624,10 @@ def list_upgrades(
Whether to include casks in the list of upgrades.
options
Additional options to pass to brew.
List of string with additional options to pass to brew.
Useful to remove ambiguous packages that can conflict between formulae and casks.
.. versionadded:: 3008.0
CLI Example:
@ -724,6 +733,12 @@ def info_installed(*names, **kwargs):
names
The names of the packages for which to return information.
options
List of string with additional options to pass to brew.
Useful to remove ambiguous packages that can conflict between formulae and casks.
.. versionadded:: 3008.0
CLI Example:
.. code-block:: bash