From d9ab52c65fb806b1b64e3747844de80550103daf Mon Sep 17 00:00:00 2001 From: Julia Kreger Date: Fri, 2 Oct 2015 15:02:18 -0400 Subject: [PATCH] Revised prep role README.md for clarity Cleaned up the variable description in order to make it more clear. Change-Id: I4c8fdd01be3730c56c0a9f31c7027d4fbf6d58a9 --- playbooks/roles/bifrost-prep-for-install/README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/playbooks/roles/bifrost-prep-for-install/README.md b/playbooks/roles/bifrost-prep-for-install/README.md index 762c1c1c3..3b8ed60bc 100644 --- a/playbooks/roles/bifrost-prep-for-install/README.md +++ b/playbooks/roles/bifrost-prep-for-install/README.md @@ -46,9 +46,13 @@ ironic_git_branch: Branch to install, defaults to "master". shade_git_branch: Branch to install, defaults to "master". -copy_from_local_path: Boolean value, defaulting to false that allows - a user to define the role to copy the files instead - of cloning fresh copies from Git. +copy_from_local_path: Boolean value, defaults to false. If set to true, + the role will attempt to perform a filesystem copy of + locally defined git repositories instead of cloning + the local repositories in order to preserve the + pre-existing repository state. This is largely + something that is needed in CI testing if dependent + changes are pre-staged in the local repositories. ci_testing_zuul: Boolean value, default false. This value is utilized to tell the prepatory playbook when the prep role