diff options
| author | Toshio Kuratomi <a.badger@gmail.com> | 2015-02-17 17:56:02 -0800 |
|---|---|---|
| committer | Toshio Kuratomi <a.badger@gmail.com> | 2015-02-17 17:56:02 -0800 |
| commit | c486c3ac06188bc45e51cdedda9d48fa29b2ac9a (patch) | |
| tree | b5ca0e98c8a92a711dce1c0ff2b00a403bc23a9b | |
| parent | 5824f7877314122e04a5dbcd5d91cb99a452f222 (diff) | |
| parent | 410862d631180902abd18e74454bf723c6d8b0cb (diff) | |
| download | ansible-modules-core-c486c3ac06188bc45e51cdedda9d48fa29b2ac9a.tar.gz | |
Merge pull request #800 from mrsheepuk/update-unarchive-docs
Doc change for unarchive - make clearer usage for existing remote file
| -rw-r--r-- | files/unarchive.py | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/files/unarchive.py b/files/unarchive.py index 8e9c90fe..7804d1bc 100644 --- a/files/unarchive.py +++ b/files/unarchive.py @@ -23,14 +23,14 @@ DOCUMENTATION = ''' --- module: unarchive version_added: 1.4 -short_description: Copies an archive to a remote location and unpack it +short_description: Unpacks an archive after (optionally) copying it from the local machine. extends_documentation_fragment: files description: - - The M(unarchive) module copies an archive file from the local machine to a remote and unpacks it. + - The M(unarchive) module unpacks an archive. By default, it will copy the source file from the local system to the target before unpacking - set copy=no to unpack an archive which already exists on the target.. options: src: description: - - Local path to archive file to copy to the remote server; can be absolute or relative. + - If copy=yes (default), local path to archive file to copy to the target server; can be absolute or relative. If copy=no, path on the target server to existing archive file to unpack. required: true default: null dest: @@ -40,7 +40,7 @@ options: default: null copy: description: - - "if true, the file is copied from the 'master' to the target machine, otherwise, the plugin will look for src archive at the target machine." + - "If true, the file is copied from local 'master' to the target machine, otherwise, the plugin will look for src archive at the target machine." required: false choices: [ "yes", "no" ] default: "yes" |