From ce466fc05d330ad65b203b171d7aeb4eaffc002a Mon Sep 17 00:00:00 2001 From: Christopher Patton Date: Sat, 30 May 2020 19:23:23 -0700 Subject: [PATCH] Update documentation to reflect practical default of upgrade --- README.md | 9 +++++---- library/aur.py | 1 + 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b24a1b2..2107e6a 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/library/aur.py b/library/aur.py index ee71767..47a643a 100644 --- a/library/aur.py +++ b/library/aur.py @@ -34,6 +34,7 @@ options: upgrade: description: - Whether or not to upgrade whole system. + default: no type: bool use: