From 5c34ed0827f88094204bbb10f714145aad084595 Mon Sep 17 00:00:00 2001
From: James Tanner <tanner.jc@gmail.com>
Date: Mon, 4 Nov 2013 12:19:31 -0500
Subject: [PATCH] Addresses #4676 Add module notes about the behavior of sudo
 and the destination paths within the synchronize module.

---
 library/files/synchronize | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/library/files/synchronize b/library/files/synchronize
index 0a10dda343..9acc4d4662 100644
--- a/library/files/synchronize
+++ b/library/files/synchronize
@@ -103,6 +103,12 @@ options:
       - Specify a --timeout for the rsync command in seconds. 
     default: 10 
     required: false
+notes:
+   - Inspect the verbose output to validate the destination user/host/path
+     are what was expected.
+   - The remote user for the dest path will always be the remote_user, not
+     the sudo_user. 
+   - Expect that dest=~/x will be ~<remote_user>/x even if using sudo.
 author: Timothy Appnel
 '''