Updated Branches: refs/heads/trunk d05449fcf -> 11d120ecc
Update libcloud.compute.deployment module docstrings. Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/799047e2 Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/799047e2 Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/799047e2 Branch: refs/heads/trunk Commit: 799047e2d56861a5f95885e3b123cdf8fffecd52 Parents: d05449f Author: Tomaz Muraus <[email protected]> Authored: Wed Sep 11 12:10:30 2013 +0200 Committer: Tomaz Muraus <[email protected]> Committed: Wed Sep 11 12:10:30 2013 +0200 ---------------------------------------------------------------------- libcloud/compute/deployment.py | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/libcloud/blob/799047e2/libcloud/compute/deployment.py ---------------------------------------------------------------------- diff --git a/libcloud/compute/deployment.py b/libcloud/compute/deployment.py index 3f68d40..b8224d5 100644 --- a/libcloud/compute/deployment.py +++ b/libcloud/compute/deployment.py @@ -59,13 +59,14 @@ class Deployment(object): class SSHKeyDeployment(Deployment): """ - Installs a public SSH Key onto a host. + Installs a public SSH Key onto a server. """ def __init__(self, key): """ - @type key: C{str} - @keyword key: Contents of the public key write + @type key: C{str} or C{File} object + @keyword key: Contents of the public key write or a file object which + can be read. """ self.key = self._get_string_value(argument_name='key', argument_value=key) @@ -82,7 +83,7 @@ class SSHKeyDeployment(Deployment): class FileDeployment(Deployment): """ - Installs a file. + Installs a file on the server. """ def __init__(self, source, target): @@ -98,7 +99,7 @@ class FileDeployment(Deployment): def run(self, node, client): """ - Upload the file, retaining permissions + Upload the file, retaining permissions. See also L{Deployment.run} """ @@ -114,17 +115,17 @@ class FileDeployment(Deployment): class ScriptDeployment(Deployment): """ - Runs an arbitrary Shell Script task. + Runs an arbitrary shell script on the server. """ def __init__(self, script, args=None, name=None, delete=False): """ @type script: C{str} - @keyword script: Contents of the script to run + @keyword script: Contents of the script to run. @type args: C{list} - @keyword args: Optional arguments which get passed to the deployment - script file. + @keyword args: Optional command line arguments which get passed to the + deployment script file. @type name: C{str} @keyword name: Name of the script to upload it as, if not specified, @@ -185,13 +186,13 @@ class ScriptDeployment(Deployment): class ScriptFileDeployment(ScriptDeployment): """ - Runs an arbitrary Shell Script task from a file. + Runs an arbitrary shell script from a local file on the server. """ def __init__(self, script_file, name=None, delete=False): """ @type script_file: C{str} - @keyword script_file: Path to a file containing the script to run + @keyword script_file: Path to a file containing the script to run. @type name: C{str} @keyword name: Name of the script to upload it as, if not specified,
