From 3ec2fde2c6e7d03a2a50f6a004a31e6c532930b1 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Fri, 24 Feb 2023 09:25:20 +0100 Subject: [PATCH] Add attributes to package manager modules (#5954) Add attributes to package manager modules. --- plugins/modules/ansible_galaxy_install.py | 7 ++++++ plugins/modules/apk.py | 7 ++++++ plugins/modules/apt_repo.py | 7 ++++++ plugins/modules/apt_rpm.py | 7 ++++++ plugins/modules/bower.py | 7 ++++++ plugins/modules/bundler.py | 7 ++++++ plugins/modules/cargo.py | 7 ++++++ plugins/modules/composer.py | 7 ++++++ plugins/modules/copr.py | 7 ++++++ plugins/modules/cpanm.py | 7 ++++++ plugins/modules/dnf_versionlock.py | 23 +++++++++++++------- plugins/modules/dpkg_divert.py | 9 ++++++-- plugins/modules/easy_install.py | 9 +++++++- plugins/modules/flatpak.py | 17 ++++++++++----- plugins/modules/flatpak_remote.py | 25 ++++++++++++++-------- plugins/modules/gem.py | 7 ++++++ plugins/modules/homebrew.py | 10 +++++++-- plugins/modules/homebrew_cask.py | 17 +++++++++------ plugins/modules/homebrew_tap.py | 7 ++++++ plugins/modules/installp.py | 9 +++++++- plugins/modules/layman.py | 7 ++++++ plugins/modules/macports.py | 7 ++++++ plugins/modules/npm.py | 7 ++++++ plugins/modules/openbsd_pkg.py | 13 ++++++++---- plugins/modules/opkg.py | 7 ++++++ plugins/modules/pacman.py | 7 ++++++ plugins/modules/pacman_key.py | 26 ++++++++++++++--------- plugins/modules/pear.py | 7 ++++++ plugins/modules/pipx.py | 7 ++++++ plugins/modules/pkg5.py | 7 ++++++ plugins/modules/pkg5_publisher.py | 7 ++++++ plugins/modules/pkgin.py | 7 ++++++ plugins/modules/pkgng.py | 7 ++++++ plugins/modules/pkgutil.py | 11 ++++++++-- plugins/modules/portage.py | 9 ++++++++ plugins/modules/portinstall.py | 7 ++++++ plugins/modules/rpm_ostree_pkg.py | 13 ++++++++---- plugins/modules/slackpkg.py | 7 ++++++ plugins/modules/snap.py | 7 ++++++ plugins/modules/snap_alias.py | 7 ++++++ plugins/modules/svr4pkg.py | 7 ++++++ plugins/modules/syspatch.py | 9 ++++++++ plugins/modules/sysupgrade.py | 7 ++++++ plugins/modules/xbps.py | 7 ++++++ plugins/modules/yarn.py | 7 ++++++ plugins/modules/yum_versionlock.py | 10 +++++++-- plugins/modules/zypper.py | 8 +++++++ plugins/modules/zypper_repository.py | 7 ++++++ 48 files changed, 386 insertions(+), 56 deletions(-) diff --git a/plugins/modules/ansible_galaxy_install.py b/plugins/modules/ansible_galaxy_install.py index 694591d8cb..0f38eabdf6 100644 --- a/plugins/modules/ansible_galaxy_install.py +++ b/plugins/modules/ansible_galaxy_install.py @@ -26,6 +26,13 @@ notes: If that one also fails, the module will fail. requirements: - Ansible 2.9, ansible-base 2.10, or ansible-core 2.11 or newer +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: none + diff_mode: + support: none options: type: description: diff --git a/plugins/modules/apk.py b/plugins/modules/apk.py index 831ab60749..e56b2165dd 100644 --- a/plugins/modules/apk.py +++ b/plugins/modules/apk.py @@ -19,6 +19,13 @@ short_description: Manages apk packages description: - Manages I(apk) packages for Alpine Linux. author: "Kevin Brebanov (@kbrebanov)" +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: available: description: diff --git a/plugins/modules/apt_repo.py b/plugins/modules/apt_repo.py index 2e9c9b109c..5560390271 100644 --- a/plugins/modules/apt_repo.py +++ b/plugins/modules/apt_repo.py @@ -19,6 +19,13 @@ description: notes: - This module works on ALT based distros. - Does NOT support checkmode, due to a limitation in apt-repo tool. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: none + diff_mode: + support: none options: repo: description: diff --git a/plugins/modules/apt_rpm.py b/plugins/modules/apt_rpm.py index d949a61e68..24d6fb13d4 100644 --- a/plugins/modules/apt_rpm.py +++ b/plugins/modules/apt_rpm.py @@ -17,6 +17,13 @@ module: apt_rpm short_description: APT-RPM package manager description: - Manages packages with I(apt-rpm). Both low-level (I(rpm)) and high-level (I(apt-get)) package manager binaries required. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: none + diff_mode: + support: none options: package: description: diff --git a/plugins/modules/bower.py b/plugins/modules/bower.py index 8964bd0434..1824e68bb8 100644 --- a/plugins/modules/bower.py +++ b/plugins/modules/bower.py @@ -16,6 +16,13 @@ short_description: Manage bower packages with bower description: - Manage bower packages with bower author: "Michael Warkentin (@mwarkentin)" +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: none + diff_mode: + support: none options: name: type: str diff --git a/plugins/modules/bundler.py b/plugins/modules/bundler.py index 5811fa720c..682dd334ac 100644 --- a/plugins/modules/bundler.py +++ b/plugins/modules/bundler.py @@ -15,6 +15,13 @@ module: bundler short_description: Manage Ruby Gem dependencies with Bundler description: - Manage installation and Gem version dependencies for Ruby using the Bundler gem +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: executable: type: str diff --git a/plugins/modules/cargo.py b/plugins/modules/cargo.py index 787edbd256..24be43741b 100644 --- a/plugins/modules/cargo.py +++ b/plugins/modules/cargo.py @@ -17,6 +17,13 @@ version_added: 4.3.0 description: - Manage Rust packages with cargo. author: "Radek Sprta (@radek-sprta)" +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: description: diff --git a/plugins/modules/composer.py b/plugins/modules/composer.py index 34a15edda5..793abcda18 100644 --- a/plugins/modules/composer.py +++ b/plugins/modules/composer.py @@ -21,6 +21,13 @@ description: Composer is a tool for dependency management in PHP. It allows you to declare the dependent libraries your project needs and it will install them in your project for you. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: command: type: str diff --git a/plugins/modules/copr.py b/plugins/modules/copr.py index 68738a6c98..965c2a935d 100644 --- a/plugins/modules/copr.py +++ b/plugins/modules/copr.py @@ -20,6 +20,13 @@ requirements: - dnf-plugins-core notes: - Supports C(check_mode). +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: host: description: The Copr host to work with. diff --git a/plugins/modules/cpanm.py b/plugins/modules/cpanm.py index 98f37d573e..b3d63e1fb1 100644 --- a/plugins/modules/cpanm.py +++ b/plugins/modules/cpanm.py @@ -16,6 +16,13 @@ module: cpanm short_description: Manages Perl library dependencies description: - Manage Perl library dependencies using cpanminus. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: none + diff_mode: + support: none options: name: type: str diff --git a/plugins/modules/dnf_versionlock.py b/plugins/modules/dnf_versionlock.py index a0a440b620..fac3ad78d4 100644 --- a/plugins/modules/dnf_versionlock.py +++ b/plugins/modules/dnf_versionlock.py @@ -18,6 +18,21 @@ description: excludes all other versions of those packages. This allows you to for example protect packages from being updated by newer versions. The state of the plugin that reflects locking of packages is the C(locklist). +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: partial + details: + - The logics of the C(versionlock) plugin for corner cases could be + confusing, so please take in account that this module will do its best to + give a C(check_mode) prediction on what is going to happen. In case of + doubt, check the documentation of the plugin. + - Sometimes the module could predict changes in C(check_mode) that will not + be such because C(versionlock) concludes that there is already a entry in + C(locklist) that already matches. + diff_mode: + support: none options: name: description: @@ -54,19 +69,11 @@ options: type: str default: present notes: - - The logics of the C(versionlock) plugin for corner cases could be - confusing, so please take in account that this module will do its best to - give a C(check_mode) prediction on what is going to happen. In case of - doubt, check the documentation of the plugin. - - Sometimes the module could predict changes in C(check_mode) that will not - be such because C(versionlock) concludes that there is already a entry in - C(locklist) that already matches. - In an ideal world, the C(versionlock) plugin would have a dry-run option to know for sure what is going to happen. So far we have to work with a best guess as close as possible to the behaviour inferred from its code. - For most of cases where you want to lock and unlock specific versions of a package, this works fairly well. - - Supports C(check_mode). requirements: - dnf - dnf-plugin-versionlock diff --git a/plugins/modules/dpkg_divert.py b/plugins/modules/dpkg_divert.py index 52e6c33d0d..4a1651f517 100644 --- a/plugins/modules/dpkg_divert.py +++ b/plugins/modules/dpkg_divert.py @@ -27,6 +27,13 @@ description: C(dpkg-divert) commandline tool. It can either create or remove a diversion for a given file, but also update an existing diversion to modify its I(holder) and/or its I(divert) location. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: full options: path: description: @@ -79,8 +86,6 @@ options: - This parameter is ignored when I(rename=false). type: bool default: false -notes: - - This module supports I(check_mode) and I(diff). requirements: - dpkg-divert >= 1.15.0 (Debian family) ''' diff --git a/plugins/modules/easy_install.py b/plugins/modules/easy_install.py index 0a3158c926..564493180a 100644 --- a/plugins/modules/easy_install.py +++ b/plugins/modules/easy_install.py @@ -14,7 +14,14 @@ DOCUMENTATION = ''' module: easy_install short_description: Installs Python libraries description: - - Installs Python libraries, optionally in a I(virtualenv) + - Installs Python libraries, optionally in a I(virtualenv) +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: type: str diff --git a/plugins/modules/flatpak.py b/plugins/modules/flatpak.py index d6264a50d3..feda6ed5b4 100644 --- a/plugins/modules/flatpak.py +++ b/plugins/modules/flatpak.py @@ -15,13 +15,20 @@ DOCUMENTATION = r''' module: flatpak short_description: Manage flatpaks description: -- Allows users to add or remove flatpaks. -- See the M(community.general.flatpak_remote) module for managing flatpak remotes. + - Allows users to add or remove flatpaks. + - See the M(community.general.flatpak_remote) module for managing flatpak remotes. author: -- John Kwiatkoski (@JayKayy) -- Alexander Bethke (@oolongbrothers) + - John Kwiatkoski (@JayKayy) + - Alexander Bethke (@oolongbrothers) requirements: -- flatpak + - flatpak +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: executable: description: diff --git a/plugins/modules/flatpak_remote.py b/plugins/modules/flatpak_remote.py index bc52d5461a..2032e38b9c 100644 --- a/plugins/modules/flatpak_remote.py +++ b/plugins/modules/flatpak_remote.py @@ -15,17 +15,24 @@ DOCUMENTATION = r''' module: flatpak_remote short_description: Manage flatpak repository remotes description: -- Allows users to add or remove flatpak remotes. -- The flatpak remotes concept is comparable to what is called repositories in other packaging - formats. -- Currently, remote addition is only supported via I(flatpakrepo) file URLs. -- Existing remotes will not be updated. -- See the M(community.general.flatpak) module for managing flatpaks. + - Allows users to add or remove flatpak remotes. + - The flatpak remotes concept is comparable to what is called repositories in other packaging + formats. + - Currently, remote addition is only supported via I(flatpakrepo) file URLs. + - Existing remotes will not be updated. + - See the M(community.general.flatpak) module for managing flatpaks. author: -- John Kwiatkoski (@JayKayy) -- Alexander Bethke (@oolongbrothers) + - John Kwiatkoski (@JayKayy) + - Alexander Bethke (@oolongbrothers) requirements: -- flatpak + - flatpak +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: executable: description: diff --git a/plugins/modules/gem.py b/plugins/modules/gem.py index a44683c786..4bc99d39ef 100644 --- a/plugins/modules/gem.py +++ b/plugins/modules/gem.py @@ -15,6 +15,13 @@ module: gem short_description: Manage Ruby gems description: - Manage installation and uninstallation of Ruby gems. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: type: str diff --git a/plugins/modules/homebrew.py b/plugins/modules/homebrew.py index a72d929a81..7592f95a41 100644 --- a/plugins/modules/homebrew.py +++ b/plugins/modules/homebrew.py @@ -22,11 +22,17 @@ author: - "Daniel Jaouen (@danieljaouen)" - "Andrew Dunham (@andrew-d)" requirements: - - "python >= 2.6" - - homebrew must already be installed on the target system + - homebrew must already be installed on the target system short_description: Package manager for Homebrew description: - Manages Homebrew packages +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: description: diff --git a/plugins/modules/homebrew_cask.py b/plugins/modules/homebrew_cask.py index 5937831962..162c184612 100644 --- a/plugins/modules/homebrew_cask.py +++ b/plugins/modules/homebrew_cask.py @@ -15,14 +15,19 @@ DOCUMENTATION = ''' --- module: homebrew_cask author: -- "Indrajit Raychaudhuri (@indrajitr)" -- "Daniel Jaouen (@danieljaouen)" -- "Enric Lluelles (@enriclluelles)" -requirements: -- "python >= 2.6" + - "Indrajit Raychaudhuri (@indrajitr)" + - "Daniel Jaouen (@danieljaouen)" + - "Enric Lluelles (@enriclluelles)" short_description: Install and uninstall homebrew casks description: -- Manages Homebrew casks. + - Manages Homebrew casks. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: description: diff --git a/plugins/modules/homebrew_tap.py b/plugins/modules/homebrew_tap.py index 7099773b21..b230dbb34c 100644 --- a/plugins/modules/homebrew_tap.py +++ b/plugins/modules/homebrew_tap.py @@ -22,6 +22,13 @@ author: short_description: Tap a Homebrew repository description: - Tap external Homebrew repositories. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: description: diff --git a/plugins/modules/installp.py b/plugins/modules/installp.py index f1421bc390..41064363db 100644 --- a/plugins/modules/installp.py +++ b/plugins/modules/installp.py @@ -12,10 +12,17 @@ DOCUMENTATION = r''' --- module: installp author: -- Kairo Araujo (@kairoaraujo) + - Kairo Araujo (@kairoaraujo) short_description: Manage packages on AIX description: - Manage packages using 'installp' on AIX +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: accept_license: description: diff --git a/plugins/modules/layman.py b/plugins/modules/layman.py index b860385969..940ac30d1b 100644 --- a/plugins/modules/layman.py +++ b/plugins/modules/layman.py @@ -21,6 +21,13 @@ description: requirements: - "python >= 2.6" - layman python module +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: description: diff --git a/plugins/modules/macports.py b/plugins/modules/macports.py index 7bf5c4f532..6f40d0938e 100644 --- a/plugins/modules/macports.py +++ b/plugins/modules/macports.py @@ -19,6 +19,13 @@ author: "Jimmy Tang (@jcftang)" short_description: Package manager for MacPorts description: - Manages MacPorts packages (ports) +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: none + diff_mode: + support: none options: name: description: diff --git a/plugins/modules/npm.py b/plugins/modules/npm.py index 02d97de766..013fd6e570 100644 --- a/plugins/modules/npm.py +++ b/plugins/modules/npm.py @@ -15,6 +15,13 @@ short_description: Manage node.js packages with npm description: - Manage node.js packages with Node Package Manager (npm). author: "Chris Hoffman (@chrishoffman)" +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: description: diff --git a/plugins/modules/openbsd_pkg.py b/plugins/modules/openbsd_pkg.py index f99c5a24d0..62a662c3c4 100644 --- a/plugins/modules/openbsd_pkg.py +++ b/plugins/modules/openbsd_pkg.py @@ -14,12 +14,17 @@ DOCUMENTATION = ''' --- module: openbsd_pkg author: -- Patrik Lundin (@eest) + - Patrik Lundin (@eest) short_description: Manage packages on OpenBSD description: - - Manage packages on OpenBSD using the pkg tools. -requirements: -- python >= 2.5 + - Manage packages on OpenBSD using the pkg tools. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: description: diff --git a/plugins/modules/opkg.py b/plugins/modules/opkg.py index 73c2597de2..360bf453b7 100644 --- a/plugins/modules/opkg.py +++ b/plugins/modules/opkg.py @@ -18,6 +18,13 @@ author: "Patrick Pelletier (@skinp)" short_description: Package manager for OpenWrt and Openembedded/Yocto based Linux distributions description: - Manages ipk packages for OpenWrt and Openembedded/Yocto based Linux distributions +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: none + diff_mode: + support: none options: name: description: diff --git a/plugins/modules/pacman.py b/plugins/modules/pacman.py index 1066f10e88..66f58155d3 100644 --- a/plugins/modules/pacman.py +++ b/plugins/modules/pacman.py @@ -23,6 +23,13 @@ author: - Aaron Bull Schaefer (@elasticdog) - Maxime de Roucy (@tchernomax) - Jean Raby (@jraby) +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: full options: name: description: diff --git a/plugins/modules/pacman_key.py b/plugins/modules/pacman_key.py index 7fa173ac3b..4d4c4afaca 100644 --- a/plugins/modules/pacman_key.py +++ b/plugins/modules/pacman_key.py @@ -12,21 +12,27 @@ DOCUMENTATION = ''' --- module: pacman_key author: -- George Rawlinson (@grawlinson) + - George Rawlinson (@grawlinson) version_added: "3.2.0" short_description: Manage pacman's list of trusted keys description: -- Add or remove gpg keys from the pacman keyring. + - Add or remove gpg keys from the pacman keyring. notes: -- Use full-length key ID (40 characters). -- Keys will be verified when using I(data), I(file), or I(url) unless I(verify) is overridden. -- Keys will be locally signed after being imported into the keyring. -- If the key ID exists in the keyring, the key will not be added unless I(force_update) is specified. -- I(data), I(file), I(url), and I(keyserver) are mutually exclusive. -- Supports C(check_mode). + - Use full-length key ID (40 characters). + - Keys will be verified when using I(data), I(file), or I(url) unless I(verify) is overridden. + - Keys will be locally signed after being imported into the keyring. + - If the key ID exists in the keyring, the key will not be added unless I(force_update) is specified. + - I(data), I(file), I(url), and I(keyserver) are mutually exclusive. requirements: -- gpg -- pacman-key + - gpg + - pacman-key +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: id: description: diff --git a/plugins/modules/pear.py b/plugins/modules/pear.py index 4e10ca0414..d7cb01b920 100644 --- a/plugins/modules/pear.py +++ b/plugins/modules/pear.py @@ -20,6 +20,13 @@ description: - Manage PHP packages with the pear package manager. author: - Jonathan Lestrelin (@jle64) +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: type: str diff --git a/plugins/modules/pipx.py b/plugins/modules/pipx.py index 773fbef8ea..f3bddef459 100644 --- a/plugins/modules/pipx.py +++ b/plugins/modules/pipx.py @@ -16,6 +16,13 @@ short_description: Manages applications installed with pipx version_added: 3.8.0 description: - Manage Python applications installed in isolated virtualenvs using pipx. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: full options: state: type: str diff --git a/plugins/modules/pkg5.py b/plugins/modules/pkg5.py index f8f6be24b9..f6bc77a713 100644 --- a/plugins/modules/pkg5.py +++ b/plugins/modules/pkg5.py @@ -18,6 +18,13 @@ description: - IPS packages are the native packages in Solaris 11 and higher. notes: - The naming of IPS packages is explained at U(http://www.oracle.com/technetwork/articles/servers-storage-admin/ips-package-versioning-2232906.html). +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: description: diff --git a/plugins/modules/pkg5_publisher.py b/plugins/modules/pkg5_publisher.py index 3ccf3d8ca1..9d1b381385 100644 --- a/plugins/modules/pkg5_publisher.py +++ b/plugins/modules/pkg5_publisher.py @@ -19,6 +19,13 @@ description: - IPS packages are the native packages in Solaris 11 and higher. - This modules will configure which publishers a client will download IPS packages from. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: none + diff_mode: + support: none options: name: description: diff --git a/plugins/modules/pkgin.py b/plugins/modules/pkgin.py index 0da06e0502..c08b252187 100644 --- a/plugins/modules/pkgin.py +++ b/plugins/modules/pkgin.py @@ -31,6 +31,13 @@ notes: - "Known bug with pkgin < 0.8.0: if a package is removed and another package depends on it, the other package will be silently removed as well. New to Ansible 1.9: check-mode support." +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: description: diff --git a/plugins/modules/pkgng.py b/plugins/modules/pkgng.py index 6e94dcaee5..b9d4422c06 100644 --- a/plugins/modules/pkgng.py +++ b/plugins/modules/pkgng.py @@ -20,6 +20,13 @@ module: pkgng short_description: Package manager for FreeBSD >= 9.0 description: - Manage binary packages for FreeBSD using 'pkgng' which is available in versions after 9.0. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: description: diff --git a/plugins/modules/pkgutil.py b/plugins/modules/pkgutil.py index d15c9d2726..5af74c1f31 100644 --- a/plugins/modules/pkgutil.py +++ b/plugins/modules/pkgutil.py @@ -23,6 +23,15 @@ description: author: - Alexander Winkler (@dermute) - David Ponessa (@scathatheworm) +extends_documentation_fragment: +- community.general.attributes +attributes: + check_mode: + support: full + details: + - In order to check the availability of packages, the catalog cache under C(/var/opt/csw/pkgutil) may be refreshed even in check mode. + diff_mode: + support: none options: name: description: @@ -57,8 +66,6 @@ options: type: bool default: false version_added: 1.2.0 -notes: -- In order to check the availability of packages, the catalog cache under C(/var/opt/csw/pkgutil) may be refreshed even in check mode. ''' EXAMPLES = r''' diff --git a/plugins/modules/portage.py b/plugins/modules/portage.py index 98791f8477..d33f44d578 100644 --- a/plugins/modules/portage.py +++ b/plugins/modules/portage.py @@ -21,6 +21,15 @@ short_description: Package manager for Gentoo description: - Manages Gentoo packages +extends_documentation_fragment: + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none + options: package: description: diff --git a/plugins/modules/portinstall.py b/plugins/modules/portinstall.py index d044756d9e..e263b71813 100644 --- a/plugins/modules/portinstall.py +++ b/plugins/modules/portinstall.py @@ -18,6 +18,13 @@ module: portinstall short_description: Installing packages from FreeBSD's ports system description: - Manage packages for FreeBSD using 'portinstall'. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: none + diff_mode: + support: none options: name: description: diff --git a/plugins/modules/rpm_ostree_pkg.py b/plugins/modules/rpm_ostree_pkg.py index 5f7632b1e1..52219cd1ba 100644 --- a/plugins/modules/rpm_ostree_pkg.py +++ b/plugins/modules/rpm_ostree_pkg.py @@ -17,6 +17,13 @@ short_description: Install or uninstall overlay additional packages version_added: "2.0.0" description: - Install or uninstall overlay additional packages using C(rpm-ostree) command. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: none + diff_mode: + support: none options: name: description: @@ -34,10 +41,8 @@ options: default: 'present' type: str author: -- Dusty Mabe (@dustymabe) -- Abhijeet Kasurde (@Akasurde) -notes: -- Does not support C(check_mode). + - Dusty Mabe (@dustymabe) + - Abhijeet Kasurde (@Akasurde) ''' EXAMPLES = r''' diff --git a/plugins/modules/slackpkg.py b/plugins/modules/slackpkg.py index 1a6cdf7705..208061a4cb 100644 --- a/plugins/modules/slackpkg.py +++ b/plugins/modules/slackpkg.py @@ -22,6 +22,13 @@ short_description: Package manager for Slackware >= 12.2 description: - Manage binary packages for Slackware using 'slackpkg' which is available in versions after 12.2. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: description: diff --git a/plugins/modules/snap.py b/plugins/modules/snap.py index 1b5e27071a..4b798d6e2c 100644 --- a/plugins/modules/snap.py +++ b/plugins/modules/snap.py @@ -18,6 +18,13 @@ module: snap short_description: Manages snaps description: - "Manages snaps packages." +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: description: diff --git a/plugins/modules/snap_alias.py b/plugins/modules/snap_alias.py index 1611c06719..71869b6ee0 100644 --- a/plugins/modules/snap_alias.py +++ b/plugins/modules/snap_alias.py @@ -16,6 +16,13 @@ short_description: Manages snap aliases version_added: 4.0.0 description: - "Manages snaps aliases." +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: full options: state: description: diff --git a/plugins/modules/svr4pkg.py b/plugins/modules/svr4pkg.py index 51e43b079f..e8c410482b 100644 --- a/plugins/modules/svr4pkg.py +++ b/plugins/modules/svr4pkg.py @@ -21,6 +21,13 @@ description: - Note that this is a very basic packaging system. It will not enforce dependencies on install or remove. author: "Boyd Adamson (@brontitall)" +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: description: diff --git a/plugins/modules/syspatch.py b/plugins/modules/syspatch.py index 36b934f299..c90ef0d227 100644 --- a/plugins/modules/syspatch.py +++ b/plugins/modules/syspatch.py @@ -18,6 +18,15 @@ short_description: Manage OpenBSD system patches description: - "Manage OpenBSD system patches using syspatch." +extends_documentation_fragment: + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none + options: revert: description: diff --git a/plugins/modules/sysupgrade.py b/plugins/modules/sysupgrade.py index e597db975b..ac80e01965 100644 --- a/plugins/modules/sysupgrade.py +++ b/plugins/modules/sysupgrade.py @@ -15,6 +15,13 @@ short_description: Manage OpenBSD system upgrades version_added: 1.1.0 description: - Manage OpenBSD system upgrades using sysupgrade. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: none + diff_mode: + support: none options: snapshot: description: diff --git a/plugins/modules/xbps.py b/plugins/modules/xbps.py index aad496238b..1fea5b384a 100644 --- a/plugins/modules/xbps.py +++ b/plugins/modules/xbps.py @@ -19,6 +19,13 @@ description: author: - "Dino Occhialini (@dinoocch)" - "Michael Aldridge (@the-maldridge)" +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: description: diff --git a/plugins/modules/yarn.py b/plugins/modules/yarn.py index df55925dba..da9f9c79c3 100644 --- a/plugins/modules/yarn.py +++ b/plugins/modules/yarn.py @@ -20,6 +20,13 @@ description: author: - "David Gunter (@verkaufer)" - "Chris Hoffman (@chrishoffman), creator of NPM Ansible module)" +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: type: str diff --git a/plugins/modules/yum_versionlock.py b/plugins/modules/yum_versionlock.py index 4835f6116c..95fd4dd7cf 100644 --- a/plugins/modules/yum_versionlock.py +++ b/plugins/modules/yum_versionlock.py @@ -14,7 +14,14 @@ module: yum_versionlock version_added: 2.0.0 short_description: Locks / unlocks a installed package(s) from being updated by yum package manager description: - - This module adds installed packages to yum versionlock to prevent the package(s) from being updated. + - This module adds installed packages to yum versionlock to prevent the package(s) from being updated. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: description: @@ -31,7 +38,6 @@ options: default: present notes: - Requires yum-plugin-versionlock package on the remote node. - - Supports C(check_mode). requirements: - yum - yum-versionlock diff --git a/plugins/modules/zypper.py b/plugins/modules/zypper.py index c5404975e8..775ff0fd6e 100644 --- a/plugins/modules/zypper.py +++ b/plugins/modules/zypper.py @@ -31,6 +31,14 @@ short_description: Manage packages on SUSE and openSUSE description: - Manage packages on SUSE and openSUSE using the zypper and rpm tools. - Also supports transactional updates, by running zypper inside C(/sbin/transactional-update --continue --drop-if-no-change --quiet run). +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: full options: name: description: diff --git a/plugins/modules/zypper_repository.py b/plugins/modules/zypper_repository.py index 9a947254c5..cccd9c5795 100644 --- a/plugins/modules/zypper_repository.py +++ b/plugins/modules/zypper_repository.py @@ -18,6 +18,13 @@ author: "Matthias Vogelgesang (@matze)" short_description: Add and remove Zypper repositories description: - Add or remove Zypper repositories on SUSE and openSUSE +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: none + diff_mode: + support: none options: name: description: