From e25caebe7a6cd5a8f31451f943fc6849b3dd847b Mon Sep 17 00:00:00 2001 From: Toshio Kuratomi Date: Fri, 18 Mar 2016 06:40:04 -0700 Subject: [PATCH] Cleanups to docs and rename of inv var --- docsite/rst/intro_configuration.rst | 2 +- docsite/rst/intro_inventory.rst | 8 ++++---- lib/ansible/playbook/play_context.py | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docsite/rst/intro_configuration.rst b/docsite/rst/intro_configuration.rst index 64070e3200..2d12825ea0 100644 --- a/docsite/rst/intro_configuration.rst +++ b/docsite/rst/intro_configuration.rst @@ -289,7 +289,7 @@ This indicates the command to use to spawn a shell under a sudo environment. Us executable = /bin/bash -Starting in version 2.1 this can be overriden by the inventory var ``ansible_executable``. +Starting in version 2.1 this can be overriden by the inventory var ``ansible_shell_executable``. .. _filter_plugins: diff --git a/docsite/rst/intro_inventory.rst b/docsite/rst/intro_inventory.rst index f8b303f597..bf103f2847 100644 --- a/docsite/rst/intro_inventory.rst +++ b/docsite/rst/intro_inventory.rst @@ -247,7 +247,7 @@ Privilege escalation (see :doc:`Ansible Privilege Escalation` for furthe Remote host environment parameters:: ansible_shell_type - The shell type of the target system. You should not use this setting unless you have set the 'executable' to a non sh compatible shell. + The shell type of the target system. You should not use this setting unless you have set the 'ansible_shell_executable' to a non sh compatible shell. By default commands are formatted using 'sh'-style syntax. Setting this to 'csh' or 'fish' will cause commands executed on target systems to follow those shell's syntax instead. ansible_python_interpreter @@ -264,9 +264,9 @@ Remote host environment parameters:: :: - ansible_executable - This sets the shell the ansible controller will use on the target machine, overrides ``executable`` in ``ansible.cfg`` which defaults to '/bin/sh'. - You should really only change it if is not possible to use '/bin/sh' (i.e. it is not in the list of allowed shells for your users). + ansible_shell_executable + This sets the shell the ansible controller will use on the target machine, overrides ``executable`` in ``ansible.cfg`` which defaults to ``/bin/sh``. + You should really only change it if is not possible to use ``/bin/sh`` (i.e. ``/bin/sh`` is not installed on the target machine.). Examples from a host file:: diff --git a/lib/ansible/playbook/play_context.py b/lib/ansible/playbook/play_context.py index de6b817055..dce14c9b7f 100644 --- a/lib/ansible/playbook/play_context.py +++ b/lib/ansible/playbook/play_context.py @@ -78,7 +78,7 @@ MAGIC_VARIABLE_MAPPING = dict( su_pass = ('ansible_su_password', 'ansible_su_pass'), su_exe = ('ansible_su_exe',), su_flags = ('ansible_su_flags',), - executable = ('ansible_executable',), + executable = ('ansible_shell_executable',), ) SU_PROMPT_LOCALIZATIONS = [