Distinguish between helpers and tools in documentation

pull/39/head
Christopher Patton 2020-05-30 19:27:03 -07:00
parent ce466fc05d
commit 707f445620
2 changed files with 4 additions and 4 deletions

View File

@ -17,7 +17,7 @@ The following helpers are supported and automatically selected, if present, in t
|name | |Name or list of names of the package(s) to install or upgrade.| |name | |Name or list of names of the package(s) to install or upgrade.|
|state |**present**, latest |Desired state of the package, 'present' skips operations if the package is already installed.| |state |**present**, latest |Desired state of the package, 'present' skips operations if the package is already installed.|
|upgrade |yes, **no** |Whether or not to upgrade whole system.| |upgrade |yes, **no** |Whether or not to upgrade whole system.|
|use |**auto**, yay, pacaur, trizen, pikaur, aurman, makepkg |The helper to use, 'auto' uses the first known helper found and makepkg as a fallback.| |use |**auto**, yay, pacaur, trizen, pikaur, aurman, makepkg |The tool to use, 'auto' uses the first known helper found and makepkg as a fallback.|
|use_args |[] |A list of arguments to pass directly to the used tool. Cannot be used unless use is set to something other than 'auto'.| |use_args |[] |A list of arguments to pass directly to the used tool. Cannot be used unless use is set to something other than 'auto'.|
|aur_only |yes, **no** |Limit helper operation to the AUR.| |aur_only |yes, **no** |Limit helper operation to the AUR.|
|skip_pgp_check |yes, **no** |Only valid with makepkg. Skip PGP signatures verification of source file, useful when installing packages without GnuPG properly configured. Cannot be used unless use is set to something other than 'auto'.| |skip_pgp_check |yes, **no** |Only valid with makepkg. Skip PGP signatures verification of source file, useful when installing packages without GnuPG properly configured. Cannot be used unless use is set to something other than 'auto'.|

View File

@ -39,7 +39,7 @@ options:
use: use:
description: description:
- The helper to use, 'auto' uses the first known helper found and makepkg as a fallback. - The tool to use, 'auto' uses the first known helper found and makepkg as a fallback.
default: auto default: auto
choices: [ auto, yay, pacaur, trizen, pikaur, aurman, makepkg ] choices: [ auto, yay, pacaur, trizen, pikaur, aurman, makepkg ]
@ -272,7 +272,7 @@ def make_module():
params = module.params params = module.params
if params['use'] == 'auto' and params['use_args']: if params['use'] == 'auto' and params['use_args']:
module.fail_json(msg="You must specify a helper other than 'auto' to use the 'use_flags' option.") module.fail_json(msg="You must specify a tool other than 'auto' to use the 'use_flags' option.")
if params['use'] != 'makepkg' and params['skip_pgp_check']: if params['use'] != 'makepkg' and params['skip_pgp_check']:
module.fail_json(msg="You must use 'makepkg' to use the 'skip_pgp_check' option.") module.fail_json(msg="You must use 'makepkg' to use the 'skip_pgp_check' option.")
@ -290,7 +290,7 @@ def make_module():
use = params['use'] use = params['use']
if params.get('upgrade', False) and use == 'makepkg': if params.get('upgrade', False) and use == 'makepkg':
module.fail_json(msg="Upgrade cannot be used with the helper 'makepkg'.") module.fail_json(msg="Upgrade cannot be used with the tool 'makepkg'.")
return module, use return module, use