summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatt Fischer <matt@mattfischer.com>2016-06-10 13:11:24 -0600
committerjctanner <tanner.jc@gmail.com>2016-06-10 15:11:24 -0400
commit1f5335d5e0360f849a8452a35bb6818289d0c73c (patch)
tree3c685dd9314b6e278154efc77116b19507d4add1
parent00fb13010c233aaa97f91f4199505f0f5cdc848c (diff)
downloadansible-modules-core-1f5335d5e0360f849a8452a35bb6818289d0c73c.tar.gz
Update delete notes for Synrhconize docs (#3723)
The example for delete=yes does not specify recursive although it is required. In addition, the wording for the delete option is confusing about from where files are really deleted. This should clarify that.
-rw-r--r--files/synchronize.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/files/synchronize.py b/files/synchronize.py
index b06e3b62..1657bd1a 100644
--- a/files/synchronize.py
+++ b/files/synchronize.py
@@ -72,7 +72,7 @@ options:
version_added: "1.5"
delete:
description:
- - Delete files that don't exist (after transfer, not before) in the C(src) path. This option requires C(recursive=yes).
+ - Delete files in C(dest) that don't exist (after transfer, not before) in the C(src) path. This option requires C(recursive=yes).
choices: [ 'yes', 'no' ]
default: 'no'
required: false
@@ -234,7 +234,7 @@ synchronize:
delegate_to: "{{ inventory_hostname }}"
# Synchronize and delete files in dest on the remote host that are not found in src of localhost.
-synchronize: src=some/relative/path dest=/some/absolute/path delete=yes
+synchronize: src=some/relative/path dest=/some/absolute/path delete=yes recursive=yes
# Synchronize using an alternate rsync command
# This specific command is granted su privileges on the destination