From 31421374c063797ab2d4219b00c672b43f39f539 Mon Sep 17 00:00:00 2001 From: mrsheepuk Date: Tue, 17 Feb 2015 13:48:59 +0000 Subject: [PATCH] Doc change - make clearer usage for existing remote file Having read the doc for this module several times and completely missing that it can be used for existing remote archives, I propose this update to the wording to make clear from the top the two ways in which this module can be used. --- lib/ansible/modules/files/unarchive.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/ansible/modules/files/unarchive.py b/lib/ansible/modules/files/unarchive.py index 8e9c90fedcc..7804d1bc02c 100644 --- a/lib/ansible/modules/files/unarchive.py +++ b/lib/ansible/modules/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"