Add attributes to package manager modules (#5954)

Add attributes to package manager modules.

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:

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:

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:

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:

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

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

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:

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

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.

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

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

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)
 '''

plugins/modules/easy_install.py

@@ -15,6 +15,13 @@ module: easy_install
 short_description: Installs Python libraries
 description:
     - 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

plugins/modules/flatpak.py

@@ -15,13 +15,20 @@ DOCUMENTATION = r'''
 module: flatpak
 short_description: Manage flatpaks
 description:
-- Allows users to add or remove flatpaks.
+  - Allows users to add or remove flatpaks.
-- See the M(community.general.flatpak_remote) module for managing flatpak remotes.
+  - See the M(community.general.flatpak_remote) module for managing flatpak remotes.
 author:
-- John Kwiatkoski (@JayKayy)
+  - John Kwiatkoski (@JayKayy)
-- Alexander Bethke (@oolongbrothers)
+  - Alexander Bethke (@oolongbrothers)
 requirements:
-- flatpak
+  - flatpak
+extends_documentation_fragment:
+  - community.general.attributes
+attributes:
+  check_mode:
+    support: full
+  diff_mode:
+    support: none
 options:
   executable:
     description:

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.
+  - Allows users to add or remove flatpak remotes.
-- The flatpak remotes concept is comparable to what is called repositories in other packaging
+  - 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.
+  - Currently, remote addition is only supported via I(flatpakrepo) file URLs.
-- Existing remotes will not be updated.
+  - Existing remotes will not be updated.
-- See the M(community.general.flatpak) module for managing flatpaks.
+  - See the M(community.general.flatpak) module for managing flatpaks.
 author:
-- John Kwiatkoski (@JayKayy)
+  - John Kwiatkoski (@JayKayy)
-- Alexander Bethke (@oolongbrothers)
+  - Alexander Bethke (@oolongbrothers)
 requirements:
-- flatpak
+  - flatpak
+extends_documentation_fragment:
+  - community.general.attributes
+attributes:
+  check_mode:
+    support: full
+  diff_mode:
+    support: none
 options:
   executable:
     description:

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

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
 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:

plugins/modules/homebrew_cask.py

@@ -15,14 +15,19 @@ DOCUMENTATION = '''
 ---
 module: homebrew_cask
 author:
-- "Indrajit Raychaudhuri (@indrajitr)"
+  - "Indrajit Raychaudhuri (@indrajitr)"
-- "Daniel Jaouen (@danieljaouen)"
+  - "Daniel Jaouen (@danieljaouen)"
-- "Enric Lluelles (@enriclluelles)"
+  - "Enric Lluelles (@enriclluelles)"
-requirements:
-- "python >= 2.6"
 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:

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:

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:

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:

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:

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:

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:
+extends_documentation_fragment:
-- python >= 2.5
+  - community.general.attributes
+attributes:
+    check_mode:
+        support: full
+    diff_mode:
+        support: none
 options:
     name:
         description:

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:

plugins/modules/pacman.py

@@ -23,6 +23,13 @@ author:
     - Aaron Bull Schaefer (@elasticdog) <aaron@elasticdog.com>
     - 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:

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).
+    - 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 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.
+    - 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.
+    - 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.
+    - I(data), I(file), I(url), and I(keyserver) are mutually exclusive.
-- Supports C(check_mode).
 requirements:
-- gpg
+    - gpg
-- pacman-key
+    - pacman-key
+extends_documentation_fragment:
+    - community.general.attributes
+attributes:
+    check_mode:
+        support: full
+    diff_mode:
+        support: none
 options:
     id:
         description:

plugins/modules/pear.py

@@ -20,6 +20,13 @@ description:
     - Manage PHP packages with the pear package manager.
 author:
     - Jonathan Lestrelin (@jle64) <jonathan.lestrelin@gmail.com>
+extends_documentation_fragment:
+    - community.general.attributes
+attributes:
+    check_mode:
+        support: full
+    diff_mode:
+        support: none
 options:
     name:
         type: str

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

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:

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:

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:

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:

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'''

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:

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:

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)
+    - Dusty Mabe (@dustymabe)
-- Abhijeet Kasurde (@Akasurde)
+    - Abhijeet Kasurde (@Akasurde)
-notes:
-- Does not support C(check_mode).
 '''
 
 EXAMPLES = r'''

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:

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:

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:

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:

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:

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:

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:

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

plugins/modules/yum_versionlock.py

@@ -15,6 +15,13 @@ 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.
+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

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:

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: