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

Update unarchive.py (#56285)

Browse source 
Clarify that the unarchive module does not unpack a compressed file, only archive files.
This commit is contained in:
mirumu 2019-05-21 08:20:13 +12:00 committed by Alicia Cozine
parent 77f3e8451c
commit 6496084697
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
lib/ansible/modules/files/unarchive.py
View file

@ -21,7 +21,7 @@ module: unarchive
version_added: '1.4' version_added: '1.4'
short_description: Unpacks an archive after (optionally) copying it from the local machine. short_description: Unpacks an archive after (optionally) copying it from the local machine.
description: description:
- The C(unarchive) module unpacks an archive. - The C(unarchive) module unpacks an archive. It will not unpack a compressed file that does not contain an archive.
- By default, it will copy the source file from the local system to the target before unpacking. - By default, it will copy the source file from the local system to the target before unpacking.
- Set C(remote_src=yes) to unpack an archive which already exists on the target. - Set C(remote_src=yes) to unpack an archive which already exists on the target.
- If checksum validation is desired, use M(get_url) or M(uri) instead to fetch the file and set C(remote_src=yes). - If checksum validation is desired, use M(get_url) or M(uri) instead to fetch the file and set C(remote_src=yes).
@ -99,6 +99,7 @@ todo:
notes: notes:
- Requires C(gtar)/C(unzip) command on target host. - Requires C(gtar)/C(unzip) command on target host.
- Can handle I(.zip) files using C(unzip) as well as I(.tar), I(.tar.gz), I(.tar.bz2) and I(.tar.xz) files using C(gtar). - Can handle I(.zip) files using C(unzip) as well as I(.tar), I(.tar.gz), I(.tar.bz2) and I(.tar.xz) files using C(gtar).
- Does not handle I(.gz) files, I(.bz2) files or I(.xz) files that do not contain a I(.tar) archive.
- Uses gtar's C(--diff) arg to calculate if changed or not. If this C(arg) is not - Uses gtar'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.
- Existing files/directories in the destination which are not in the archive - Existing files/directories in the destination which are not in the archive