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

improve force_archive parameter documentation of archive module (#2052) (#2079)

Browse source 
* improve documentation for force_archive parameter

* add link to unarchive module

Co-authored-by: Felix Fontein <felix@fontein.de>

Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit af441aecfc)

Co-authored-by: Triantafyllos <ttsak@hotmail.com>
This commit is contained in:
patchback[bot] 2021-03-22 20:55:37 +01:00 committed by GitHub
parent 62e3a2ed2f
commit 53e7e48834
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
plugins/modules/files/archive.py
View file

@ -44,8 +44,9 @@ options:
elements: path elements: path
force_archive: force_archive:
description: description:
- Allow you to force the module to treat this as an archive even if only a single file is specified. - Allows you to force the module to treat this as an archive even if only a single file is specified.
- By default behaviour is maintained. i.e A when a single file is specified it is compressed only (not archived). - By default when a single file is specified it is compressed only (not archived).
- Enable this if you want to use M(ansible.builtin.unarchive) on an archive of a single file created with this module.
type: bool type: bool
default: false default: false
remove: remove: