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

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

Browse source 
(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
Show stats Download patch file Download diff file Expand all files Collapse all files

2
plugins/modules/packaging/language/composer.py
View file

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

2
plugins/modules/packaging/os/layman.py
View file

@ -25,7 +25,7 @@ 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 C(state=updated)).
Use 'ALL' to sync all of the installed overlays (can be used only when I(state=updated)).
required: true
type: str
list_url:

6
plugins/modules/packaging/os/pacman.py
View file

@ -45,9 +45,9 @@ options:
force:
description:
- 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.
Same as C(update_cache_extra_args="--refresh --refresh").
Same as I(update_cache_extra_args="--refresh --refresh").
default: false
type: bool
@ -115,7 +115,7 @@ options:
reason_for:
description:
- 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
choices: [ all, new ]
type: str

4
plugins/modules/packaging/os/pkgng.py
View file

@ -24,10 +24,10 @@ options:
name:
description:
- 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
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
the machines disk. Avoid using them unless you are certain that
your role will only be used with newer versions.

2
plugins/modules/packaging/os/pkgutil.py
View file

@ -27,7 +27,7 @@ options:
name:
description:
- 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
required: true
elements: str

2
plugins/modules/packaging/os/sorcery.py
View file

@ -39,7 +39,7 @@ options:
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 C(update_cache=true)
- state C(latest) always triggers I(update_cache=true)
- state C(rebuild) implies cast of all specified spells, not only
those existed before
choices: ["present", "latest", "absent", "cast", "dispelled", "rebuild"]

4
plugins/modules/packaging/os/svr4pkg.py
View file

@ -39,13 +39,13 @@ options:
src:
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)."
- 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
proxy:
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
response_file:
description:

2
plugins/modules/packaging/os/zypper.py
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
update the package within the version range given.
- 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
aliases: [ 'pkg' ]
type: list

4
plugins/modules/remote_management/cobbler/cobbler_system.py
View file

@ -137,11 +137,11 @@ EXAMPLES = r'''
RETURN = r'''
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
system:
description: (Resulting) information about the system we are working with
returned: when C(name) is provided
returned: when I(name) is provided
type: dict
'''

4
plugins/modules/source_control/github/github_key.py
View file

@ -27,7 +27,7 @@ options:
type: str
pubkey:
description:
- SSH public key value. Required when C(state=present).
- SSH public key value. Required when I(state=present).
type: str
state:
description:
@ -39,7 +39,7 @@ options:
description:
- 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
set if no key with the given C(name) exists.
set if no key with the given I(name) exists.
type: bool
default: true

2
plugins/modules/system/dconf.py
View file

@ -34,7 +34,7 @@ notes:
- 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
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.
- When using loops in combination with a value like
:code:`"[('xkb', 'us'), ('xkb', 'se')]"`, you need to be aware of possible

2
plugins/modules/system/open_iscsi.py
View file

@ -78,7 +78,7 @@ options:
- Whether the list of target nodes on the portal should be
(re)discovered and added to the persistent iSCSI database.
- 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.
type: bool
default: false

2
plugins/modules/system/osx_defaults.py
View file

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

2
plugins/modules/web_infrastructure/htpasswd.py
View file

@ -56,7 +56,7 @@ options:
type: bool
default: true
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
file does not exist
notes: