doc: Document --syntax-check flag for ansible-playbook (#22256)

It wasn't previously documented outside of the help / manpage, which made it less discoverable.
This commit is contained in:
Adam Johnson 2017-03-04 11:11:41 -08:00 committed by scottb
parent 72c96b3ac3
commit d01ac3a019

View file

@ -453,6 +453,9 @@ There's also a `clever playbook <https://github.com/ansible/ansible-examples/blo
Tips and Tricks Tips and Tricks
``````````````` ```````````````
To check the syntax of a playbook, use ``ansible-playbook`` with the ``--syntax-check`` flag. This will run the
playbook file through the parser to ensure its included files, roles, etc. have no syntax problems.
Look at the bottom of the playbook execution for a summary of the nodes that were targeted Look at the bottom of the playbook execution for a summary of the nodes that were targeted
and how they performed. General failures and fatal "unreachable" communication attempts are and how they performed. General failures and fatal "unreachable" communication attempts are
kept separate in the counts. kept separate in the counts.