From cc12b85e49a73ebb97120adc8caa0061e103532c Mon Sep 17 00:00:00 2001 From: Scott Sturdivant Date: Tue, 18 Jun 2013 09:25:51 -0600 Subject: [PATCH] Document the 'default' argument for vars_prompt. --- docsite/latest/rst/playbooks2.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docsite/latest/rst/playbooks2.rst b/docsite/latest/rst/playbooks2.rst index 362e6b20587..fd4fa1de793 100644 --- a/docsite/latest/rst/playbooks2.rst +++ b/docsite/latest/rst/playbooks2.rst @@ -186,6 +186,15 @@ in a push-script:: There are full examples of both of these items in the github examples/playbooks directory. +If you have a variable that changes infrequently, it might make sense to +provide a default value that can be overriden. This can be accomplished using +the default argument:: + + vars_prompt: + - name: "release_version" + prompt: "Product release version" + default: "1.0" + An alternative form of vars_prompt allows for hiding input from the user, and may later support some other options, but otherwise works equivalently::