From 8b83f9c14e0aa992865955bdc26a3391cb4e4c48 Mon Sep 17 00:00:00 2001 From: chris-kiick-sp <43998532+chris-kiick-sp@users.noreply.github.com> Date: Mon, 11 Nov 2019 14:46:03 -0600 Subject: [PATCH] archive module documentation is misleading (#62755) --- lib/ansible/modules/files/archive.py | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/lib/ansible/modules/files/archive.py b/lib/ansible/modules/files/archive.py index 56aa69ee40f..26c112601df 100644 --- a/lib/ansible/modules/files/archive.py +++ b/lib/ansible/modules/files/archive.py @@ -20,10 +20,8 @@ version_added: '2.3' short_description: Creates a compressed archive of one or more files or trees extends_documentation_fragment: files description: - - 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. + - Creates or extends an archive. + - The source and archive are on the remote host, and the archive I(is not) copied to the local host. - Source files can be deleted after archival by specifying I(remove=True). options: path: @@ -40,7 +38,7 @@ options: default: gz dest: 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. type: path exclude_path: