summaryrefslogtreecommitdiff
path: root/docsite
diff options
context:
space:
mode:
authorMichael DeHaan <michael@ansible.com>2014-08-22 15:33:57 -0400
committerMichael DeHaan <michael@ansible.com>2014-08-22 15:37:07 -0400
commit7ffa9cecaef12a17a5fc5053938a6dfbf7171c23 (patch)
treeac58b331bf2c3bfff67eac5775cccbe82553c58b /docsite
parentfcb610dec4ae6fa81064fe5a402f23d9e4f639ca (diff)
downloadansible-7ffa9cecaef12a17a5fc5053938a6dfbf7171c23.tar.gz
Docs for command warnings feature.
Diffstat (limited to 'docsite')
-rw-r--r--docsite/rst/intro_configuration.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/docsite/rst/intro_configuration.rst b/docsite/rst/intro_configuration.rst
index 1500b80c5b..b5f797fb5e 100644
--- a/docsite/rst/intro_configuration.rst
+++ b/docsite/rst/intro_configuration.rst
@@ -127,6 +127,30 @@ different locations::
Most users will not need to use this feature. See :doc:`developing_plugins` for more details
+.. _command_warnings:
+
+command_warnings
+================
+
+.. versionadded:: 1.8
+
+By default since Ansible 1.8, Ansible will warn when usage of the shell and
+command module appear to be simplified by using a default Ansible module
+instead. This can include reminders to use the 'git' module instead of
+shell commands to execute 'git'. Using modules when possible over arbitrary
+shell commands can lead to more reliable and consistent playbook runs, and
+also easier to maintain playbooks.
+
+ command_warnings=False
+
+These warnings can be silenced by adjusting the following
+setting or adding warn=yes or warn=no to the end of the command line
+parameter string, like so::
+
+
+ - name: usage of git that could be replaced with the git module
+ shell: git update foo warn=yes
+
.. _connection_plugins:
connection_plugins