mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-28 21:31:26 -07:00
[PR #9421/2a2a9661 backport][stable-10] [ab]*.py: normalize docs (#9427)
[ab]*.py: normalize docs (#9421)
* [ab]*.py: normalize docs
* Update plugins/modules/atomic_image.py
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 2a2a9661d9
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
3db0a11148
commit
14038511a1
36 changed files with 1931 additions and 2013 deletions
|
@ -12,8 +12,7 @@ from __future__ import absolute_import, division, print_function
|
|||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: apk
|
||||
short_description: Manages apk packages
|
||||
description:
|
||||
|
@ -29,15 +28,15 @@ attributes:
|
|||
options:
|
||||
available:
|
||||
description:
|
||||
- During upgrade, reset versioned world dependencies and change logic to prefer replacing or downgrading packages (instead of holding them)
|
||||
if the currently installed package is no longer available from any repository.
|
||||
- During upgrade, reset versioned world dependencies and change logic to prefer replacing or downgrading packages (instead
|
||||
of holding them) if the currently installed package is no longer available from any repository.
|
||||
type: bool
|
||||
default: false
|
||||
name:
|
||||
description:
|
||||
- A package name, like V(foo), or multiple packages, like V(foo,bar).
|
||||
- Do not include additional whitespace when specifying multiple packages as a string.
|
||||
Prefer YAML lists over comma-separating multiple package names.
|
||||
- Do not include additional whitespace when specifying multiple packages as a string. Prefer YAML lists over comma-separating
|
||||
multiple package names.
|
||||
type: list
|
||||
elements: str
|
||||
no_cache:
|
||||
|
@ -48,8 +47,8 @@ options:
|
|||
version_added: 1.0.0
|
||||
repository:
|
||||
description:
|
||||
- A package repository or multiple repositories.
|
||||
Unlike with the underlying apk command, this list will override the system repositories rather than supplement them.
|
||||
- A package repository or multiple repositories. Unlike with the underlying apk command, this list will override the
|
||||
system repositories rather than supplement them.
|
||||
type: list
|
||||
elements: str
|
||||
state:
|
||||
|
@ -59,7 +58,7 @@ options:
|
|||
- V(absent) ensures the package(s) is/are absent. V(removed) can be used as an alias.
|
||||
- V(latest) ensures the package(s) is/are present and the latest version(s).
|
||||
default: present
|
||||
choices: [ "present", "absent", "latest", "installed", "removed" ]
|
||||
choices: ["present", "absent", "latest", "installed", "removed"]
|
||||
type: str
|
||||
update_cache:
|
||||
description:
|
||||
|
@ -73,17 +72,18 @@ options:
|
|||
default: false
|
||||
world:
|
||||
description:
|
||||
- Use a custom world file when checking for explicitly installed packages.
|
||||
The file is used only when a value is provided for O(name), and O(state) is set to V(present) or V(latest).
|
||||
- Use a custom world file when checking for explicitly installed packages. The file is used only when a value is provided
|
||||
for O(name), and O(state) is set to V(present) or V(latest).
|
||||
type: str
|
||||
default: /etc/apk/world
|
||||
version_added: 5.4.0
|
||||
notes:
|
||||
- 'O(name) and O(upgrade) are mutually exclusive.'
|
||||
- When used with a C(loop:) each package will be processed individually, it is much more efficient to pass the list directly to the O(name) option.
|
||||
'''
|
||||
- O(name) and O(upgrade) are mutually exclusive.
|
||||
- When used with a C(loop:) each package will be processed individually, it is much more efficient to pass the list directly
|
||||
to the O(name) option.
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Update repositories and install foo package
|
||||
community.general.apk:
|
||||
name: foo
|
||||
|
@ -157,15 +157,15 @@ EXAMPLES = '''
|
|||
name: foo
|
||||
state: latest
|
||||
world: /etc/apk/world.custom
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
RETURN = r"""
|
||||
packages:
|
||||
description: a list of packages that have been changed
|
||||
returned: when packages have changed
|
||||
type: list
|
||||
sample: ['package', 'other-package']
|
||||
'''
|
||||
description: A list of packages that have been changed.
|
||||
returned: when packages have changed
|
||||
type: list
|
||||
sample: ['package', 'other-package']
|
||||
"""
|
||||
|
||||
import re
|
||||
# Import module snippets.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue