1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-02-04 07:51:50 +00:00

Use semantic markup (modules a-c) (#6671)

* Use semantic markup.

* E() now works better.
This commit is contained in:
Felix Fontein 2023-06-15 15:46:33 +02:00 committed by GitHub
parent 7ae8cc9902
commit 6fc1df9b83
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
32 changed files with 193 additions and 200 deletions

View file

@ -17,7 +17,7 @@ DOCUMENTATION = '''
module: apk
short_description: Manages apk packages
description:
- Manages I(apk) packages for Alpine Linux.
- Manages C(apk) packages for Alpine Linux.
author: "Kevin Brebanov (@kbrebanov)"
extends_documentation_fragment:
- community.general.attributes
@ -35,7 +35,7 @@ options:
default: false
name:
description:
- A package name, like C(foo), or multiple packages, like C(foo, bar).
- A package name, like V(foo), or multiple packages, like V(foo, bar).
type: list
elements: str
no_cache:
@ -53,9 +53,9 @@ options:
state:
description:
- Indicates the desired package(s) state.
- C(present) ensures the package(s) is/are present. C(installed) can be used as an alias.
- C(absent) ensures the package(s) is/are absent. C(removed) can be used as an alias.
- C(latest) ensures the package(s) is/are present and the latest version(s).
- V(present) ensures the package(s) is/are present. V(installed) can be used as an alias.
- 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" ]
type: str
@ -76,8 +76,8 @@ options:
default: /etc/apk/world
version_added: 5.4.0
notes:
- 'I(name) and I(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 I(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 = '''