ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-27 07:01:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

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
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. short_description: Creates a compressed archive of one or more files or trees.
extends_documentation_fragment: files extends_documentation_fragment: files
description: 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: options:
path: path:
description: description:
@ -38,7 +38,7 @@ options:
required: true required: true
format: format:
description: description:
- The type of compression to use. Can be 'gz', 'bz2', or 'zip'. - The type of compression to use.
choices: [ 'gz', 'bz2', 'zip' ] choices: [ 'gz', 'bz2', 'zip' ]
default: 'gz' default: 'gz'
dest: dest:
@ -49,7 +49,6 @@ options:
remove: remove:
description: description:
- Remove any added source files and trees after adding to archive. - Remove any added source files and trees after adding to archive.
type: bool
required: false required: false
default: false default: false