Merge pull request #2188 from ag-wood/win_template_fix

Minor fix for display of \r\n in doco

1 files changed, 17 insertions, 2 deletions

diff --git a/windows/win_template.py b/windows/win_template.py
index c384ad77..54f3bcef 100644
--- a/windows/win_template.py
+++ b/windows/win_template.py
@@ -1,5 +1,20 @@
 # this is a virtual module that is entirely implemented server side
 
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
 DOCUMENTATION = '''
 ---
 module: win_template
@@ -32,8 +47,8 @@ notes:
   - "templates are loaded with C(trim_blocks=True)."
   - By default, windows line endings are not created in the generated file.
   - "In order to ensure windows line endings are in the generated file, add the following header
-    as the first line of your template: #jinja2: newline_sequence:'\r\n' and ensure each line
-    of the template ends with \r\n"
+    as the first line of your template: #jinja2: newline_sequence:'\\\\r\\\\n' and ensure each line
+    of the template ends with \\\\r\\\\n."
   - Beware fetching files from windows machines when creating templates
     because certain tools, such as Powershell ISE,  and regedit's export facility
     add a Byte Order Mark as the first character of the file, which can cause tracebacks.