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

adamchainz · dharmabumstead · commit d01ac3a0197e · 2017-03-04T11:11:41.000-08:00
It wasn't previously documented outside of the help / manpage, which made it less discoverable.
diff --git a/docs/docsite/rst/playbooks_intro.rst b/docs/docsite/rst/playbooks_intro.rst
@@ -453,6 +453,9 @@ There's also a `clever playbook <https://github.com/ansible/ansible-examples/blo
 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
 and how they performed.   General failures and fatal "unreachable" communication attempts are
 kept separate in the counts.
