ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-24 03:11:24 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

[PR #6683/eff0cb0e backport][stable-7] Use semantic markup (modules r-s) (#6707)

Browse source 
Use semantic markup (modules r-s) (#6683)

* Use semantic markup.

* Use 'ignore:' for alias reference.

* Ignore sanity errors for older ansible-core versions.

* Improve markup for RHSM modules.

Co-authored-by: Pino Toscano <ptoscano@redhat.com>

* 'ignore:' is no longer needed.

* E() now works better.

---------

Co-authored-by: Pino Toscano <ptoscano@redhat.com>
(cherry picked from commit eff0cb0ed9)

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
patchback[bot] 2023-06-15 19:05:11 +02:00 • committed by GitHub
parent f4af31b76b
commit 34c4b1f367
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
49 changed files with 311 additions and 303 deletions
Download patch file Download diff file Expand all files Collapse all files

30
plugins/modules/sorcery.py
View file

@ -36,8 +36,8 @@ options:
description:
- Name of the spell
- multiple names can be given, separated by commas
- special value '*' in conjunction with states C(latest) or
C(rebuild) will update or rebuild the whole system respectively
- special value '*' in conjunction with states V(latest) or
V(rebuild) will update or rebuild the whole system respectively
aliases: ["spell"]
type: list
elements: str
@ -45,9 +45,9 @@ options:
state:
description:
- Whether to cast, dispel or rebuild a package
- state C(cast) is an equivalent of C(present), not C(latest)
- state C(latest) always triggers I(update_cache=true)
- state C(rebuild) implies cast of all specified spells, not only
- state V(cast) is an equivalent of V(present), not V(latest)
- state V(latest) always triggers O(update_cache=true)
- state V(rebuild) implies cast of all specified spells, not only
those existed before
choices: ["present", "latest", "absent", "cast", "dispelled", "rebuild"]
default: "present"
@ -57,31 +57,31 @@ options:
description:
- Comma-separated list of _optional_ dependencies to build a spell
(or make sure it is built) with; use +/- in front of dependency
to turn it on/off ('+' is optional though)
- this option is ignored if C(name) parameter is equal to '*' or
contains more than one spell
- providers must be supplied in the form recognized by Sorcery, e.g.
'openssl(SSL)'
to turn it on/off ('+' is optional though).
- this option is ignored if O(name) parameter is equal to V(*) or
contains more than one spell.
- providers must be supplied in the form recognized by Sorcery, for example
'openssl(SSL)'.
type: str
update:
description:
- Whether or not to update sorcery scripts at the very first stage
- Whether or not to update sorcery scripts at the very first stage.
type: bool
default: false
update_cache:
description:
- Whether or not to update grimoire collection before casting spells
- Whether or not to update grimoire collection before casting spells.
type: bool
default: false
aliases: ["update_codex"]
cache_valid_time:
description:
- Time in seconds to invalidate grimoire collection on update
- especially useful for SCM and rsync grimoires
- makes sense only in pair with C(update_cache)
- Time in seconds to invalidate grimoire collection on update.
- Especially useful for SCM and rsync grimoires.
- Makes sense only in pair with O(update_cache).
type: int
default: 0
'''