From 51c48d4c801fecce9d2486ce956a2602eb8a0ea9 Mon Sep 17 00:00:00 2001 From: Ian Wienand Date: Wed, 25 Mar 2015 06:26:03 +1100 Subject: [PATCH] Add a note on default values of globals Add a note on default values of globals in plugin settings Change-Id: I0d5d3a7e0597abe7e2401f8bae30ccc5682eab03 --- doc/source/plugins.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/source/plugins.rst b/doc/source/plugins.rst index 5a610634b4..c4ed2285cb 100644 --- a/doc/source/plugins.rst +++ b/doc/source/plugins.rst @@ -113,6 +113,11 @@ directory. Inside this directory there can be 2 files. services using ``run_process`` as it only works with enabled services. + Be careful to allow users to override global-variables for + customizing their environment. Usually it is best to provide a + default value only if the variable is unset or empty; e.g. in bash + syntax ``FOO=${FOO:-default}``. + - ``plugin.sh`` - the actual plugin. It will be executed by devstack during it's run. The run order will be done in the registration order for these plugins, and will occur immediately after all in