From 7ead1c14fc54dc02388f407fc31854c7e60c34a5 Mon Sep 17 00:00:00 2001
From: Abhijeet Kasurde <akasurde@redhat.com>
Date: Tue, 24 Mar 2020 13:59:03 +0530
Subject: [PATCH] homebrew: Doc fixes (#36)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
---
plugins/modules/packaging/os/homebrew.py | 19 ++++++++++++-------
tests/sanity/ignore-2.10.txt | 7 -------
2 files changed, 12 insertions(+), 14 deletions(-)
diff --git a/plugins/modules/packaging/os/homebrew.py b/plugins/modules/packaging/os/homebrew.py
index bc09612e10..174a7a7547 100644
--- a/plugins/modules/packaging/os/homebrew.py
+++ b/plugins/modules/packaging/os/homebrew.py
@@ -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,
diff --git a/tests/sanity/ignore-2.10.txt b/tests/sanity/ignore-2.10.txt
index bd6f021413..63a17028a8 100644
--- a/tests/sanity/ignore-2.10.txt
+++ b/tests/sanity/ignore-2.10.txt
@@ -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