documentation: Add warning for pathexpand interpolation function

Note that the `pathexpand` interpolation function could cause an unwanted diff on two different hosts
This commit is contained in:
Jake Champlin 2017-01-20 09:51:25 -05:00
parent 2c70855782
commit be45816c80
No known key found for this signature in database
GPG Key ID: DC31F41958EF4AC2
1 changed files with 2 additions and 1 deletions

View File

@ -271,7 +271,8 @@ The supported built-in functions are:
* `md5(string)` - Returns a (conventional) hexadecimal representation of the
MD5 hash of the given string.
* `pathexpand(string)` - Returns a filepath string with `~` expanded to the home directory.
* `pathexpand(string)` - Returns a filepath string with `~` expanded to the home directory. Note:
This will create a plan diff between two different hosts, unless the filepaths are the same.
* `replace(string, search, replace)` - Does a search and replace on the
given string. All instances of `search` are replaced with the value