From 14841e453a53225302d26ead2df65c7e78f1cb67 Mon Sep 17 00:00:00 2001 From: tterranigma Date: Tue, 6 Feb 2018 15:59:47 +0100 Subject: [PATCH] Fix config option descriptions (#35638) * Fix config option descriptions * Better describe ANSIBLE_PRIVATE_ROLE_VARS --- lib/ansible/config/base.yml | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/lib/ansible/config/base.yml b/lib/ansible/config/base.yml index 0262ba8d41f..8dfe354e929 100644 --- a/lib/ansible/config/base.yml +++ b/lib/ansible/config/base.yml @@ -260,7 +260,7 @@ COLOR_ERROR: COLOR_HIGHLIGHT: name: Color for highlighting default: white - description: Color used for highlights + description: Defines the color to use for highlighting env: [{name: ANSIBLE_COLOR_HIGHLIGHT}] ini: - {key: highlight, section: colors} @@ -315,7 +315,7 @@ COMMAND_WARNINGS: default: True 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. - - 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}] ini: - {key: command_warnings, section: defaults} @@ -850,7 +850,10 @@ DEFAULT_PRIVATE_KEY_FILE: DEFAULT_PRIVATE_ROLE_VARS: name: Private role variables 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}] ini: - {key: private_role_vars, section: defaults}