1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

multiple modules: fixed markups in doc (#5227) (#5233)

(cherry picked from commit 6e011f00f4)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2022-09-04 15:59:57 +02:00 committed by GitHub
parent f2e1abfe5e
commit 3427e02fce
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 20 additions and 20 deletions

View file

@ -41,7 +41,7 @@ options:
description: description:
- Directory of your project (see --working-dir). This is required when - Directory of your project (see --working-dir). This is required when
the command is not run globally. the command is not run globally.
- Will be ignored if C(global_command=true). - Will be ignored if I(global_command=true).
global_command: global_command:
description: description:
- Runs the specified command globally. - Runs the specified command globally.

View file

@ -25,7 +25,7 @@ options:
name: name:
description: description:
- The overlay id to install, synchronize, or uninstall. - The overlay id to install, synchronize, or uninstall.
Use 'ALL' to sync all of the installed overlays (can be used only when C(state=updated)). Use 'ALL' to sync all of the installed overlays (can be used only when I(state=updated)).
required: true required: true
type: str type: str
list_url: list_url:

View file

@ -45,9 +45,9 @@ options:
force: force:
description: description:
- When removing packages, forcefully remove them, without any checks. - When removing packages, forcefully remove them, without any checks.
Same as C(extra_args="--nodeps --nodeps"). Same as I(extra_args="--nodeps --nodeps").
When combined with I(update_cache), force a refresh of all package databases. When combined with I(update_cache), force a refresh of all package databases.
Same as C(update_cache_extra_args="--refresh --refresh"). Same as I(update_cache_extra_args="--refresh --refresh").
default: false default: false
type: bool type: bool
@ -115,7 +115,7 @@ options:
reason_for: reason_for:
description: description:
- Set the install reason for C(all) packages or only for C(new) packages. - Set the install reason for C(all) packages or only for C(new) packages.
- In case of C(state=latest) already installed packages which will be updated to a newer version are not counted as C(new). - In case of I(state=latest) already installed packages which will be updated to a newer version are not counted as C(new).
default: new default: new
choices: [ all, new ] choices: [ all, new ]
type: str type: str

View file

@ -24,10 +24,10 @@ options:
name: name:
description: description:
- Name or list of names of packages to install/remove. - Name or list of names of packages to install/remove.
- "With I(name=*), I(state: latest) will operate, but I(state: present) and I(state: absent) will be noops." - "With I(name=*), I(state=latest) will operate, but I(state=present) and I(state=absent) will be noops."
- > - >
Warning: In Ansible 2.9 and earlier this module had a misfeature Warning: In Ansible 2.9 and earlier this module had a misfeature
where I(name=*) with I(state: latest) or I(state: present) would where I(name=*) with I(state=latest) or I(state=present) would
install every package from every package repository, filling up install every package from every package repository, filling up
the machines disk. Avoid using them unless you are certain that the machines disk. Avoid using them unless you are certain that
your role will only be used with newer versions. your role will only be used with newer versions.

View file

@ -27,7 +27,7 @@ options:
name: name:
description: description:
- The name of the package. - The name of the package.
- When using C(state=latest), this can be C('*'), which updates all installed packages managed by pkgutil. - When using I(state=latest), this can be C('*'), which updates all installed packages managed by pkgutil.
type: list type: list
required: true required: true
elements: str elements: str

View file

@ -39,7 +39,7 @@ options:
description: description:
- Whether to cast, dispel or rebuild a package - Whether to cast, dispel or rebuild a package
- state C(cast) is an equivalent of C(present), not C(latest) - state C(cast) is an equivalent of C(present), not C(latest)
- state C(latest) always triggers C(update_cache=true) - state C(latest) always triggers I(update_cache=true)
- state C(rebuild) implies cast of all specified spells, not only - state C(rebuild) implies cast of all specified spells, not only
those existed before those existed before
choices: ["present", "latest", "absent", "cast", "dispelled", "rebuild"] choices: ["present", "latest", "absent", "cast", "dispelled", "rebuild"]

View file

@ -39,13 +39,13 @@ options:
src: src:
description: description:
- Specifies the location to install the package from. Required when C(state=present). - Specifies the location to install the package from. Required when I(state=present).
- "Can be any path acceptable to the C(pkgadd) command's C(-d) option. e.g.: C(somefile.pkg), C(/dir/with/pkgs), C(http:/server/mypkgs.pkg)." - "Can be any path acceptable to the C(pkgadd) command's C(-d) option. e.g.: C(somefile.pkg), C(/dir/with/pkgs), C(http:/server/mypkgs.pkg)."
- If using a file or directory, they must already be accessible by the host. See the M(ansible.builtin.copy) module for a way to get them there. - If using a file or directory, they must already be accessible by the host. See the M(ansible.builtin.copy) module for a way to get them there.
type: str type: str
proxy: proxy:
description: description:
- HTTP[s] proxy to be used if C(src) is a URL. - HTTP[s] proxy to be used if I(src) is a URL.
type: str type: str
response_file: response_file:
description: description:

View file

@ -38,7 +38,7 @@ options:
- Can include a version like C(name=1.0), C(name>3.4) or C(name<=2.7). If a version is given, C(oldpackage) is implied and zypper is allowed to - Can include a version like C(name=1.0), C(name>3.4) or C(name<=2.7). If a version is given, C(oldpackage) is implied and zypper is allowed to
update the package within the version range given. update the package within the version range given.
- You can also pass a url or a local path to a rpm file. - You can also pass a url or a local path to a rpm file.
- When using state=latest, this can be '*', which updates all installed packages. - When using I(state=latest), this can be '*', which updates all installed packages.
required: true required: true
aliases: [ 'pkg' ] aliases: [ 'pkg' ]
type: list type: list

View file

@ -137,11 +137,11 @@ EXAMPLES = r'''
RETURN = r''' RETURN = r'''
systems: systems:
description: List of systems description: List of systems
returned: C(state=query) and C(name) is not provided returned: I(state=query) and I(name) is not provided
type: list type: list
system: system:
description: (Resulting) information about the system we are working with description: (Resulting) information about the system we are working with
returned: when C(name) is provided returned: when I(name) is provided
type: dict type: dict
''' '''

View file

@ -27,7 +27,7 @@ options:
type: str type: str
pubkey: pubkey:
description: description:
- SSH public key value. Required when C(state=present). - SSH public key value. Required when I(state=present).
type: str type: str
state: state:
description: description:
@ -39,7 +39,7 @@ options:
description: description:
- The default is C(true), which will replace the existing remote key - The default is C(true), which will replace the existing remote key
if it's different than C(pubkey). If C(false), the key will only be if it's different than C(pubkey). If C(false), the key will only be
set if no key with the given C(name) exists. set if no key with the given I(name) exists.
type: bool type: bool
default: true default: true

View file

@ -34,7 +34,7 @@ notes:
- Keep in mind that the C(dconf) CLI tool, which this module wraps around, - Keep in mind that the C(dconf) CLI tool, which this module wraps around,
utilises an unusual syntax for the values (GVariant). For example, if you utilises an unusual syntax for the values (GVariant). For example, if you
wanted to provide a string value, the correct syntax would be wanted to provide a string value, the correct syntax would be
C(value="'myvalue'") - with single quotes as part of the Ansible parameter I(value="'myvalue'") - with single quotes as part of the Ansible parameter
value. value.
- When using loops in combination with a value like - When using loops in combination with a value like
:code:`"[('xkb', 'us'), ('xkb', 'se')]"`, you need to be aware of possible :code:`"[('xkb', 'us'), ('xkb', 'se')]"`, you need to be aware of possible

View file

@ -78,7 +78,7 @@ options:
- Whether the list of target nodes on the portal should be - Whether the list of target nodes on the portal should be
(re)discovered and added to the persistent iSCSI database. (re)discovered and added to the persistent iSCSI database.
- Keep in mind that C(iscsiadm) discovery resets configuration, like C(node.startup) - Keep in mind that C(iscsiadm) discovery resets configuration, like C(node.startup)
to manual, hence combined with C(auto_node_startup=true) will always return to manual, hence combined with I(auto_node_startup=true) will always return
a changed state. a changed state.
type: bool type: bool
default: false default: false

View file

@ -51,7 +51,7 @@ options:
value: value:
description: description:
- The value to write. - The value to write.
- Only required when C(state=present). - Only required when I(state=present).
type: raw type: raw
state: state:
description: description:

View file

@ -56,7 +56,7 @@ options:
type: bool type: bool
default: true default: true
description: description:
- Used with C(state=present). If specified, the file will be created - Used with I(state=present). If specified, the file will be created
if it does not already exist. If set to C(false), will fail if the if it does not already exist. If set to C(false), will fail if the
file does not exist file does not exist
notes: notes: