From bf021e25b88b2641c6b3dcd4fe6f8d7f8a3f78ea Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Thu, 25 Apr 2013 08:45:23 -0400 Subject: [PATCH] Clarify script module documentation a minor amount. --- script | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/script b/script index 0e0b5138034..c5e0e0b9270 100644 --- a/script +++ b/script @@ -2,11 +2,12 @@ DOCUMENTATION = """ --- module: script -short_description: Runs a local script on a remote node +short_description: Runs a local script on a remote node after transferring it description: - The M(script) module takes the script name followed by a list of space-delimited arguments. - - The given script will be processed through the shell environment. + - The pathed local script will be transfered to the remote node and then executed. + - The given script will be processed through the shell environment on the remote node. - This module does not require python on the remote system, much like the M(raw) module. options: @@ -20,7 +21,7 @@ examples: - description: "Example from Ansible Playbooks" code: "action: script /some/local/script.sh --some-arguments 1234" notes: - - It is preferable to write Ansible modules than pushing scripts. Convert your script to an Ansible module for bonus points! + - It is usually preferable to write Ansible modules than pushing scripts. Convert your script to an Ansible module for bonus points! author: Michael DeHaan """