internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-06 21:32:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

archive docs formatting (#21454)

Browse Source
This commit is contained in:
John R Barker
2017-02-15 11:24:05 +00:00
committed by GitHub
parent 8a41b16e0f
commit 86e2feffc1
1 changed files with 2 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
lib/ansible/modules/files/archive.py
View File

@@ -30,7 +30,7 @@ version_added: 2.3
short_description: Creates a compressed archive of one or more files or trees.
extends_documentation_fragment: files
description:
- The C(archive) module packs an archive. It is the opposite of the unarchive module. By default, it assumes the compression source exists on the target. It will not copy the source file from the local system to the target before archiving. Source files can be deleted after archival by specifying C(remove)=I(True).
- Packs an archive. It is the opposite of M(unarchive). By default, it assumes the compression source exists on the target. It will not copy the source file from the local system to the target before archiving. Source files can be deleted after archival by specifying I(remove=True).
options:
path:
description:
@@ -38,7 +38,7 @@ options:
required: true
format:
description:
- The type of compression to use. Can be 'gz', 'bz2', or 'zip'.
- The type of compression to use.
choices: [ 'gz', 'bz2', 'zip' ]
default: 'gz'
dest:
@@ -49,7 +49,6 @@ options:
remove:
description:
- Remove any added source files and trees after adding to archive.
type: bool
required: false
default: false