Addresses #4676 Add module notes about the behavior of sudo and the destination paths within the synchronize module.

This commit is contained in:
James Tanner 2013-11-04 12:19:31 -05:00
parent 403469bf19
commit 7b3fbeee16

View file

@ -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
'''