Fix config option descriptions (#35638)

* Fix config option descriptions

* Better describe ANSIBLE_PRIVATE_ROLE_VARS
This commit is contained in:
tterranigma 2018-02-06 15:59:47 +01:00 committed by ansibot
parent 98f804ecb4
commit 14841e453a

View file

@ -260,7 +260,7 @@ COLOR_ERROR:
COLOR_HIGHLIGHT: COLOR_HIGHLIGHT:
name: Color for highlighting name: Color for highlighting
default: white default: white
description: Color used for highlights description: Defines the color to use for highlighting
env: [{name: ANSIBLE_COLOR_HIGHLIGHT}] env: [{name: ANSIBLE_COLOR_HIGHLIGHT}]
ini: ini:
- {key: highlight, section: colors} - {key: highlight, section: colors}
@ -315,7 +315,7 @@ COMMAND_WARNINGS:
default: True default: True
description: description:
- By default Ansible will issue a warning when the shell or command module is used and the command appears to be similar to an existing Ansible module. - By default Ansible will issue a warning when the shell or command module is used and the command appears to be similar to an existing Ansible module.
- These warnings can be silenced by adjusting this setting to False. You can also control this at the task level with the module optoin ``warn``. - These warnings can be silenced by adjusting this setting to False. You can also control this at the task level with the module option ``warn``.
env: [{name: ANSIBLE_COMMAND_WARNINGS}] env: [{name: ANSIBLE_COMMAND_WARNINGS}]
ini: ini:
- {key: command_warnings, section: defaults} - {key: command_warnings, section: defaults}
@ -850,7 +850,10 @@ DEFAULT_PRIVATE_KEY_FILE:
DEFAULT_PRIVATE_ROLE_VARS: DEFAULT_PRIVATE_ROLE_VARS:
name: Private role variables name: Private role variables
default: False default: False
description: '' description:
- Makes role variables inaccessible from other roles.
- This was introduced as a way to reset role variables to default values if
a role is used more than once in a playbook.
env: [{name: ANSIBLE_PRIVATE_ROLE_VARS}] env: [{name: ANSIBLE_PRIVATE_ROLE_VARS}]
ini: ini:
- {key: private_role_vars, section: defaults} - {key: private_role_vars, section: defaults}