fix misc. documentation typos and formatting for modules starting with s (#83420)

pull/83578/head
Alexei Znamensky 5 months ago committed by GitHub
parent 9cdfcd9aed
commit 313f9d9f69
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -35,8 +35,8 @@ options:
commands unless necessary.
- V(restarted) will always bounce the service.
- V(reloaded) will always reload.
- B(At least one of state and enabled are required.)
- Note that reloaded will start the service if it is not already started,
- At least one of O(state) and O(enabled) are required.
- Note that V(reloaded) will start the service if it is not already started,
even if your chosen init system wouldn't normally.
type: str
choices: [ reloaded, restarted, started, stopped ]
@ -52,7 +52,7 @@ options:
pattern:
description:
- If the service does not respond to the status command, name a
substring to look for as would be found in the output of the I(ps)
substring to look for as would be found in the output of the C(ps)
command as a stand-in for a status result.
- If the string is found, the service will be assumed to be started.
- While using remote hosts with systemd this setting will be ignored.
@ -61,7 +61,7 @@ options:
enabled:
description:
- Whether the service should start on boot.
- B(At least one of state and enabled are required.)
- At least one of O(state) and O(enabled) are required.
type: bool
runlevel:
description:
@ -80,7 +80,7 @@ options:
use:
description:
- The service module actually uses system specific modules, normally through auto detection, this setting can force a specific module.
- Normally it uses the value of the 'ansible_service_mgr' fact and falls back to the old 'service' module when none matching is found.
- Normally it uses the value of the C(ansible_service_mgr) fact and falls back to the C(ansible.legacy.service) module when none matching is found.
- The 'old service module' still uses autodetection and in no way does it correspond to the C(service) command.
type: str
default: auto

@ -22,7 +22,7 @@ options:
required: true
per_host:
description:
- whether the stats are per host or for all hosts in the run.
- Whether the stats are per host or for all hosts in the run.
type: bool
default: no
aggregate:

@ -11,7 +11,7 @@ module: stat
version_added: "1.3"
short_description: Retrieve file or file system status
description:
- Retrieves facts for a file similar to the Linux/Unix 'stat' command.
- Retrieves facts for a file similar to the Linux/Unix C(stat) command.
- For Windows targets, use the M(ansible.windows.win_stat) module instead.
options:
path:
@ -44,8 +44,8 @@ options:
version_added: "2.0"
get_mime:
description:
- Use file magic and return data about the nature of the file. this uses
the 'file' utility found on most Linux/Unix systems.
- Use file magic and return data about the nature of the file. This uses
the C(file) utility found on most Linux/Unix systems.
- This will add both RV(stat.mimetype) and RV(stat.charset) fields to the return, if possible.
- In Ansible 2.3 this option changed from O(mime) to O(get_mime) and the default changed to V(true).
type: bool

@ -42,7 +42,7 @@ options:
in_place:
description:
- If the directory exists, then the working copy will be checked-out over-the-top using
svn checkout --force; if force is specified then existing files with different content are reverted.
C(svn checkout --force); if force is specified then existing files with different content are reverted.
type: bool
default: "no"
version_added: "2.6"

@ -34,7 +34,7 @@ options:
choices: [ reloaded, restarted, started, stopped ]
enabled:
description:
- Whether the unit should start on boot. B(At least one of state and enabled are required.)
- Whether the unit should start on boot. At least one of O(state) and O(enabled) are required.
- If set, requires O(name).
type: bool
force:
@ -49,8 +49,8 @@ options:
type: bool
daemon_reload:
description:
- Run daemon-reload before doing any other operations, to make sure systemd has read any changes.
- When set to V(true), runs daemon-reload even if the module does not start or stop anything.
- Run C(daemon-reload) before doing any other operations, to make sure systemd has read any changes.
- When set to V(true), runs C(daemon-reload) even if the module does not start or stop anything.
type: bool
default: no
aliases: [ daemon-reload ]
@ -63,9 +63,9 @@ options:
version_added: "2.8"
scope:
description:
- Run systemctl within a given service manager scope, either as the default system scope V(system),
- Run C(systemctl) within a given service manager scope, either as the default system scope V(system),
the current user's scope V(user), or the scope of all users V(global).
- "For systemd to work with 'user', the executing user must have its own instance of dbus started and accessible (systemd requirement)."
- "For systemd to work with V(user), the executing user must have its own instance of dbus started and accessible (systemd requirement)."
- "The user dbus process is normally started during normal login, but not during the run of Ansible tasks.
Otherwise you will probably get a 'Failed to connect to bus: no such file or directory' error."
- The user must have access, normally given via setting the C(XDG_RUNTIME_DIR) variable, see the example below.
@ -95,7 +95,7 @@ notes:
- Globs are not supported in name, in other words, C(postgres*.service).
- The service names might vary by specific OS/distribution.
- The order of execution when having multiple properties is to first enable/disable, then mask/unmask and then deal with the service state.
It has been reported that systemctl can behave differently depending on the order of operations if you do the same manually.
It has been reported that C(systemctl) can behave differently depending on the order of operations if you do the same manually.
requirements:
- A system managed by systemd.
'''

@ -31,7 +31,7 @@ options:
enabled:
type: bool
description:
- Whether the service should start on boot. B(At least one of state and enabled are required.)
- Whether the service should start on boot. At least one of O(state) and O(enabled) are required.
sleep:
default: 1
description:
@ -42,7 +42,7 @@ options:
description:
- A substring to look for as would be found in the output of the I(ps) command as a stand-in for a status result.
- If the string is found, the service will be assumed to be running.
- "This option is mainly for use with init scripts that don't support the 'status' option."
- "This option is mainly for use with init scripts that don't support the C(status) option."
type: str
runlevels:
description:
@ -74,7 +74,7 @@ attributes:
platforms: posix
notes:
- One option other than name is required.
- The service names might vary by specific OS/distribution
- The service names might vary by specific OS/distribution.
requirements:
- That the service managed has a corresponding init script.
'''

Loading…
Cancel
Save