Update documentation to reflect practical default of upgrade

pull/39/head
Christopher Patton 2020-05-30 19:23:23 -07:00
parent 6cc320a5e2
commit ce466fc05d
2 changed files with 6 additions and 4 deletions

View File

@ -13,14 +13,15 @@ The following helpers are supported and automatically selected, if present, in t
## Options
|Parameter |Choices/**Default** |Comments|
|--- |--- |---|
|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.|
|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_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.|
|skip_pgp_check |yes, **no** |Only valid with makepkg. Skip PGP signatures verification of source file, useful when installing packages without GnuPG properly configured.|
|ignore_arch |yes, **no** |Only valid with makepkg. Ignore a missing or incomplete arch field, useful when the PKGBUILD does not have the arch=('yourarch') field.|
|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'.|
|ignore_arch |yes, **no** |Only valid with makepkg. Ignore a missing or incomplete arch field, useful when the PKGBUILD does not have the arch=('yourarch') field. Cannot be used unless use is set to something other than 'auto'.|
### Note
* Either *name* or *upgrade* is required, both cannot be used together.

View File

@ -34,6 +34,7 @@ options:
upgrade:
description:
- Whether or not to upgrade whole system.
default: no
type: bool
use: