homebrew: Add explicit documentation for 'path' argument (with expected default)
In Homebew, a formula is installed in a location relative to the actual `brew` command. The documentation clarifies that. Additionally, removed redundant 'path' reconstruction in multiple places.
This commit is contained in:
parent
205115ea1f
commit
3b5c7f2936
1 changed files with 10 additions and 9 deletions
|
@ -37,6 +37,11 @@ options:
|
||||||
- name of package to install/remove
|
- name of package to install/remove
|
||||||
required: false
|
required: false
|
||||||
default: None
|
default: None
|
||||||
|
path:
|
||||||
|
description:
|
||||||
|
- ':' separated list of paths to search for 'brew' executable. 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.
|
||||||
|
required: false
|
||||||
|
default: '/usr/local/bin'
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- state of the package
|
- state of the package
|
||||||
|
@ -303,7 +308,7 @@ class Homebrew(object):
|
||||||
return package
|
return package
|
||||||
# /class properties -------------------------------------------- }}}
|
# /class properties -------------------------------------------- }}}
|
||||||
|
|
||||||
def __init__(self, module, path=None, packages=None, state=None,
|
def __init__(self, module, path, packages=None, state=None,
|
||||||
update_homebrew=False, upgrade_all=False,
|
update_homebrew=False, upgrade_all=False,
|
||||||
install_options=None):
|
install_options=None):
|
||||||
if not install_options:
|
if not install_options:
|
||||||
|
@ -329,13 +334,8 @@ class Homebrew(object):
|
||||||
setattr(self, key, val)
|
setattr(self, key, val)
|
||||||
|
|
||||||
def _prep(self):
|
def _prep(self):
|
||||||
self._prep_path()
|
|
||||||
self._prep_brew_path()
|
self._prep_brew_path()
|
||||||
|
|
||||||
def _prep_path(self):
|
|
||||||
if not self.path:
|
|
||||||
self.path = ['/usr/local/bin']
|
|
||||||
|
|
||||||
def _prep_brew_path(self):
|
def _prep_brew_path(self):
|
||||||
if not self.module:
|
if not self.module:
|
||||||
self.brew_path = None
|
self.brew_path = None
|
||||||
|
@ -770,7 +770,10 @@ def main():
|
||||||
required=False,
|
required=False,
|
||||||
type='list',
|
type='list',
|
||||||
),
|
),
|
||||||
path=dict(required=False),
|
path=dict(
|
||||||
|
default="/usr/local/bin",
|
||||||
|
required=False,
|
||||||
|
),
|
||||||
state=dict(
|
state=dict(
|
||||||
default="present",
|
default="present",
|
||||||
choices=[
|
choices=[
|
||||||
|
@ -808,8 +811,6 @@ def main():
|
||||||
path = p['path']
|
path = p['path']
|
||||||
if path:
|
if path:
|
||||||
path = path.split(':')
|
path = path.split(':')
|
||||||
else:
|
|
||||||
path = ['/usr/local/bin']
|
|
||||||
|
|
||||||
state = p['state']
|
state = p['state']
|
||||||
if state in ('present', 'installed'):
|
if state in ('present', 'installed'):
|
||||||
|
|
Loading…
Add table
Reference in a new issue