Use semantic markup (modules k-l) (#6678)

* Use semantic markup.

* Use option instead of alias.
This commit is contained in:
Felix Fontein 2023-06-15 15:47:13 +02:00 committed by GitHub
parent 3e0d84bdda
commit c694abbdf9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
26 changed files with 249 additions and 250 deletions

View file

@ -32,27 +32,27 @@ options:
name:
description:
- The overlay id to install, synchronize, or uninstall.
Use 'ALL' to sync all of the installed overlays (can be used only when I(state=updated)).
Use 'ALL' to sync all of the installed overlays (can be used only when O(state=updated)).
required: true
type: str
list_url:
description:
- An URL of the alternative overlays list that defines the overlay to install.
This list will be fetched and saved under C(${overlay_defs})/${name}.xml), where
This list will be fetched and saved under C(${overlay_defs}/${name}.xml), where
C(overlay_defs) is readed from the Layman's configuration.
aliases: [url]
type: str
state:
description:
- Whether to install (C(present)), sync (C(updated)), or uninstall (C(absent)) the overlay.
- Whether to install (V(present)), sync (V(updated)), or uninstall (V(absent)) the overlay.
default: present
choices: [present, absent, updated]
type: str
validate_certs:
description:
- If C(false), SSL certificates will not be validated. This should only be
set to C(false) when no other option exists. Prior to 1.9.3 the code
defaulted to C(false).
- If V(false), SSL certificates will not be validated. This should only be
set to V(false) when no other option exists. Prior to 1.9.3 the code
defaulted to V(false).
type: bool
default: true
'''