doc style adjustments: modules [ab]* (#10350)

* doc style adjustments: modules [ab]*

* Update plugins/modules/btrfs_subvolume.py

* Update plugins/modules/aerospike_migrations.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/aix_filesystem.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/bigpanda.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* aix_filesystems: roll back wording for `filesystem` description

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2025-07-08 06:50:35 +12:00 committed by GitHub
commit 7a4448d45c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
21 changed files with 74 additions and 77 deletions

View file

@ -28,8 +28,8 @@ version_added: 10.2.0
options:
accept_licenses:
description:
- If this is set to V(true), the module will try to accept license prompts generated by C(sdkmanager) during package
installation. Otherwise, every license prompt will be rejected.
- If this is set to V(true), the module attempts to accept license prompts generated by C(sdkmanager) during package
installation. Otherwise, every license prompt is rejected.
type: bool
default: false
name:
@ -64,16 +64,16 @@ requirements:
notes:
- For some of the packages installed by C(sdkmanager) is it necessary to accept licenses. Usually it is done through command
line prompt in a form of a Y/N question when a licensed package is requested to be installed. If there are several packages
requested for installation and at least two of them belong to different licenses, the C(sdkmanager) tool will prompt for
these licenses in a loop. In order to install packages, the module must be able to answer these license prompts. Currently,
requested for installation and at least two of them belong to different licenses, the C(sdkmanager) tool prompts for these
licenses in a loop. In order to install packages, the module must be able to answer these license prompts. Currently,
it is only possible to answer one license prompt at a time, meaning that instead of installing multiple packages as a
single invocation of the C(sdkmanager --install) command, it will be done by executing the command independently for each
package. This makes sure that at most only one license prompt will need to be answered. At the time of writing this module,
a C(sdkmanager)'s package may belong to at most one license type that needs to be accepted. However, if this changes in
the future, the module may hang as there might be more prompts generated by the C(sdkmanager) tool which the module will
not be able to answer. If this becomes the case, file an issue and in the meantime, consider accepting all the licenses
in advance, as it is described in the C(sdkmanager) L(documentation,https://developer.android.com/tools/sdkmanager#accept-licenses),
for instance, using the M(ansible.builtin.command) module.
single invocation of the C(sdkmanager --install) command, it is done by executing the command independently for each package.
This makes sure that at most only one license prompt needs to be answered. At the time of writing this module, a C(sdkmanager)'s
package may belong to at most one license type that needs to be accepted. However, if this changes in the future, the
module may hang as there might be more prompts generated by the C(sdkmanager) tool which the module is unable to answer.
If this becomes the case, file an issue and in the meantime, consider accepting all the licenses in advance, as it is
described in the C(sdkmanager) L(documentation,https://developer.android.com/tools/sdkmanager#accept-licenses), for instance,
using the M(ansible.builtin.command) module.
seealso:
- name: sdkmanager tool documentation
description: Detailed information of how to install and use sdkmanager command line tool.
@ -126,13 +126,13 @@ installed:
description: A list of packages that have been installed.
returned: when packages have changed
type: list
sample: ['build-tools;34.0.0', 'platform-tools']
sample: ["build-tools;34.0.0", "platform-tools"]
removed:
description: A list of packages that have been removed.
returned: when packages have changed
type: list
sample: ['build-tools;34.0.0', 'platform-tools']
sample: ["build-tools;34.0.0", "platform-tools"]
"""
from ansible_collections.community.general.plugins.module_utils.mh.module_helper import StateModuleHelper