Moar love to the deployment classes docstrings.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/ae9f2cab Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/ae9f2cab Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/ae9f2cab Branch: refs/heads/trunk Commit: ae9f2cab3b6000c0a3d4b8d183590f66b0ae8586 Parents: 44f45ce Author: Tomaz Muraus <[email protected]> Authored: Wed Sep 11 13:13:24 2013 +0200 Committer: Tomaz Muraus <[email protected]> Committed: Wed Sep 11 13:13:24 2013 +0200 ---------------------------------------------------------------------- libcloud/compute/deployment.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/libcloud/blob/ae9f2cab/libcloud/compute/deployment.py ---------------------------------------------------------------------- diff --git a/libcloud/compute/deployment.py b/libcloud/compute/deployment.py index 653460f..c569186 100644 --- a/libcloud/compute/deployment.py +++ b/libcloud/compute/deployment.py @@ -116,6 +116,12 @@ class FileDeployment(Deployment): class ScriptDeployment(Deployment): """ Runs an arbitrary shell script on the server. + + This step works by first writting the content of the shell script (script + argument) in a *.sh file on a remote server and then running that file. + + If you are running a non-shell script, make sure to the the appropriate + shebang to the top of the script. """ def __init__(self, script, args=None, name=None, delete=False): @@ -186,7 +192,9 @@ class ScriptDeployment(Deployment): class ScriptFileDeployment(ScriptDeployment): """ - Runs an arbitrary shell script from a local file on the server. + Runs an arbitrary shell script from a local file on the server. Same as + ScriptDeployment, except that you can pass in a path to the file instead of + the script content. """ def __init__(self, script_file, args=None, name=None, delete=False):
