cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

archive module documentation is misleading (#62755)

Browse source
This commit is contained in:
chris-kiick-sp 2019-11-11 14:46:03 -06:00 committed by Sandra McCann
parent a5dc11cdd1
commit 8b83f9c14e
1 changed files with 3 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
lib/ansible/modules/files/archive.py
View file

@ -20,10 +20,8 @@ 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:
- Packs an archive. - Creates or extends an archive.
- It is the opposite of M(unarchive). - The source and archive are on the remote host, and the archive I(is not) copied to the local host.
- 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). - Source files can be deleted after archival by specifying I(remove=True).
options: options:
path: path:
@ -40,7 +38,7 @@ options:
default: gz default: gz
dest: dest:
description: description:
- The file name of the destination archive. - The file name of the destination archive. The parent directory must exists on the remote host.
- This is required when C(path) refers to multiple files by either specifying a glob, a directory or multiple paths in a list. - This is required when C(path) refers to multiple files by either specifying a glob, a directory or multiple paths in a list.
type: path type: path
exclude_path: exclude_path: