diff options
| author | Adam Johnson <me@adamj.eu> | 2017-03-04 11:11:41 -0800 |
|---|---|---|
| committer | scottb <dharmabumstead@users.noreply.github.com> | 2017-03-04 11:11:41 -0800 |
| commit | d01ac3a0197e49c6c2090f7d97a33ffe5fcf9c3c (patch) | |
| tree | 6c2f0a6db23bbec13e6d835c4bbdf49d1ebcc253 | |
| parent | 72c96b3ac30ad17fad3dda69836478fd1e54492d (diff) | |
| download | ansible-d01ac3a0197e49c6c2090f7d97a33ffe5fcf9c3c.tar.gz | |
doc: Document --syntax-check flag for ansible-playbook (#22256)
It wasn't previously documented outside of the help / manpage, which made it less discoverable.
| -rw-r--r-- | docs/docsite/rst/playbooks_intro.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/docsite/rst/playbooks_intro.rst b/docs/docsite/rst/playbooks_intro.rst index 6be2c1826e..adeb5cbfd4 100644 --- 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. |