From ae8015667c76a0db29941c433526880594baf1fa Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Mon, 30 Dec 2024 20:00:20 +0100 Subject: [PATCH] [PR #9470/f55899d6 backport][stable-9] svc: adjustments to docs (#9478) svc: adjustments to docs (#9470) * svc: adjustments to docs * Update plugins/modules/svc.py Co-authored-by: Felix Fontein --------- Co-authored-by: Felix Fontein (cherry picked from commit f55899d6efb61bab0bc7776ed32b8d39ca1fd6ca) Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> --- plugins/modules/svc.py | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/plugins/modules/svc.py b/plugins/modules/svc.py index 17667c2cc8..110b61856a 100644 --- a/plugins/modules/svc.py +++ b/plugins/modules/svc.py @@ -12,9 +12,9 @@ DOCUMENTATION = r""" module: svc author: - Brian Coca (@bcoca) -short_description: Manage daemontools services +short_description: Manage C(daemontools) services description: - - Controls daemontools services on remote hosts using the svc utility. + - Controls C(daemontools) services on remote hosts using the C(svc) utility. extends_documentation_fragment: - community.general.attributes attributes: @@ -30,23 +30,24 @@ options: required: true state: description: - - V(started)/V(stopped) are idempotent actions that will not run commands unless necessary. V(restarted) will always bounce the svc (svc - -t) and V(killed) will always bounce the svc (svc -k). V(reloaded) will send a sigusr1 (svc -1). V(once) will run a normally downed svc - once (svc -o), not really an idempotent operation. + - V(started)/V(stopped) are idempotent actions that will not run commands unless necessary. + - V(restarted) will always bounce the svc (svc -t) and V(killed) will always bounce the svc (svc -k). + - V(reloaded) will send a sigusr1 (svc -1). + - V(once) will run a normally downed svc once (svc -o), not really an idempotent operation. type: str choices: [killed, once, reloaded, restarted, started, stopped] downed: description: - - Should a 'down' file exist or not, if it exists it disables auto startup. Defaults to no. Downed does not imply stopped. + - Should a C(down) file exist or not, if it exists it disables auto startup. Defaults to V(false). Downed does not imply stopped. type: bool enabled: description: - - Whether the service is enabled or not, if disabled it also implies stopped. Take note that a service can be enabled and downed (no auto + - Whether the service is enabled or not, if disabled it also implies O(state=stopped). Take note that a service can be enabled and downed (no auto restart). type: bool service_dir: description: - - Directory svscan watches for services. + - Directory C(svscan) watches for services. type: str default: /service service_src: