1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

homebrew: Doc fixes (#36)

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
This commit is contained in:
Abhijeet Kasurde 2020-03-24 13:59:03 +05:30 committed by GitHub
parent 0a710c2a03
commit 7ead1c14fc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 14 deletions

View file

@ -34,8 +34,8 @@ description:
options:
name:
description:
- list of names of packages to install/remove
aliases: ['pkg', 'package', 'formula']
- A list of names of packages to install/remove.
aliases: [ 'formula', 'package', 'pkg' ]
type: list
elements: str
path:
@ -44,27 +44,31 @@ options:
Since a package (I(formula) in homebrew parlance) location is prefixed relative to the actual path of I(brew) command,
providing an alternative I(brew) path enables managing different set of packages in an alternative location in the system."
default: '/usr/local/bin'
type: path
state:
description:
- state of the package
choices: [ 'head', 'latest', 'present', 'absent', 'linked', 'unlinked' ]
- state of the package.
choices: [ 'absent', 'head', 'installed', 'latest', 'linked', 'present', 'removed', 'uninstalled', 'unlinked', 'upgraded' ]
default: present
type: str
update_homebrew:
description:
- update homebrew itself first
- update homebrew itself first.
type: bool
default: 'no'
aliases: ['update-brew']
upgrade_all:
description:
- upgrade all homebrew packages
- upgrade all homebrew packages.
type: bool
default: 'no'
aliases: ['upgrade']
install_options:
description:
- options flags to install a package
- options flags to install a package.
aliases: ['options']
type: list
elements: str
notes:
- When used with a `loop:` each package will be processed individually,
it is much more efficient to pass the list directly to the `name` option.
@ -852,6 +856,7 @@ def main():
default=None,
aliases=['options'],
type='list',
elements='str',
)
),
supports_check_mode=True,

View file

@ -2841,18 +2841,11 @@ plugins/modules/packaging/os/flatpak.py validate-modules:parameter-type-not-in-d
plugins/modules/packaging/os/flatpak.py validate-modules:use-run-command-not-popen
plugins/modules/packaging/os/flatpak_remote.py validate-modules:parameter-type-not-in-doc
plugins/modules/packaging/os/flatpak_remote.py validate-modules:use-run-command-not-popen
plugins/modules/packaging/os/homebrew.py validate-modules:doc-choices-do-not-match-spec
plugins/modules/packaging/os/homebrew.py validate-modules:doc-missing-type
plugins/modules/packaging/os/homebrew.py validate-modules:parameter-invalid
plugins/modules/packaging/os/homebrew.py validate-modules:parameter-list-no-elements
plugins/modules/packaging/os/homebrew.py validate-modules:parameter-type-not-in-doc
plugins/modules/packaging/os/homebrew_cask.py validate-modules:doc-choices-do-not-match-spec
plugins/modules/packaging/os/homebrew_cask.py validate-modules:doc-required-mismatch
plugins/modules/packaging/os/homebrew_cask.py validate-modules:parameter-invalid
plugins/modules/packaging/os/homebrew_cask.py validate-modules:parameter-list-no-elements
plugins/modules/packaging/os/homebrew_tap.py validate-modules:doc-missing-type
plugins/modules/packaging/os/homebrew_tap.py validate-modules:parameter-list-no-elements
plugins/modules/packaging/os/homebrew_tap.py validate-modules:parameter-type-not-in-doc
plugins/modules/packaging/os/installp.py validate-modules:parameter-list-no-elements
plugins/modules/packaging/os/layman.py validate-modules:doc-missing-type
plugins/modules/packaging/os/layman.py validate-modules:undocumented-parameter