updated --diff docs

This commit is contained in:
Brian Coca 2017-07-18 11:27:28 -04:00 committed by Brian Coca
parent 119c9e5d6e
commit 74e9e4bcbd

View file

@ -86,9 +86,10 @@ Showing Differences with ``--diff``
.. versionadded:: 1.1
The ``--diff`` option to ansible-playbook works great with ``--check`` (detailed above) but can also be used by itself. When this flag is supplied, if any templated files on the remote system are changed, and the ansible-playbook CLI will report back
the textual changes made to the file (or, if used with ``--check``, the changes that would have been made). Since the diff
feature produces a large amount of output, it is best used when checking a single host at a time, like so::
The ``--diff`` option to ansible-playbook works great with ``--check`` (detailed above) but can also be used by itself.
When this flag is supplied and the modules supports this, Ansible will report back the changes made or, if used with ``--check``, the changes that would have been made.
This is mostly used in modules that manipulate files (i.e. template) but other modules might also show 'before and after' information (i.e. user).
Since the diff feature produces a large amount of output, it is best used when checking a single host at a time, like so::
ansible-playbook foo.yml --check --diff --limit foo.example.com