Skip to content

Commit

Permalink
doc: Document --syntax-check flag for ansible-playbook (ansible#22256)
Browse files Browse the repository at this point in the history
It wasn't previously documented outside of the help / manpage, which made it less discoverable.
  • Loading branch information
adamchainz authored and dharmabumstead committed Mar 4, 2017
1 parent 72c96b3 commit d01ac3a
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/docsite/rst/playbooks_intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit d01ac3a

Please sign in to comment.