ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Merge pull request #5699 from jpmens/un1

Browse source 
module unarchive: documentation typos
This commit is contained in:
jctanner 2014-01-21 06:36:49 -08:00
commit 5e886b8ca6
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
library/files/unarchive
View file

@ -23,9 +23,9 @@ DOCUMENTATION = '''
--- ---
module: unarchive module: unarchive
version_added: 1.4 version_added: 1.4
short_description: Copies archive to remote locations and unpacks them short_description: Copies an archive to a remote location and unpack it
description: description:
- The M(unarchive) module copies an archive file on the local box to remote locations and unpacks them. - The M(unarchive) module copies an archive file from the local machine to a remote and unpacks it.
options: options:
src: src:
description: description:
@ -42,10 +42,10 @@ todo:
- detect changed/unchanged for .zip files - detect changed/unchanged for .zip files
- handle common unarchive args, like preserve owner/timestamp etc... - handle common unarchive args, like preserve owner/timestamp etc...
notes: notes:
- requires tar/unzip command on host - requires C(tar)/C(unzip) command on target host
- can handle gzip, bzip2 and xz compressed as well as uncompressed tar files - can handle I(gzip), I(bzip2) and I(xz) compressed as well as uncompressed tar files
- detects type of archive automatically - detects type of archive automatically
- uses tar's --diff arg to calculate if changed or not. If this arg is not - uses tar's C(--diff arg) to calculate if changed or not. If this C(arg) is not
supported, it will always unpack the archive supported, it will always unpack the archive
- does not detect if a .zip file is different from destination - always unzips - does not detect if a .zip file is different from destination - always unzips
- existing files/directories in the destination which are not in the archive - existing files/directories in the destination which are not in the archive