openstack/devstack
Code Issues Proposed changes

Add a note on default values of globals

Browse Source 
Add a note on default values of globals in plugin settings

Change-Id: I0d5d3a7e0597abe7e2401f8bae30ccc5682eab03
This commit is contained in:
Ian Wienand 2015-03-25 06:26:03 +11:00
parent 4e81d247a4
commit 51c48d4c80
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/source/plugins.rst
View File

@ -113,6 +113,11 @@ directory. Inside this directory there can be 2 files.
services using ``run_process`` as it only works with enabled services using ``run_process`` as it only works with enabled
services. 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 - ``plugin.sh`` - the actual plugin. It will be executed by devstack
during it's run. The run order will be done in the registration during it's run. The run order will be done in the registration
order for these plugins, and will occur immediately after all in order for these plugins, and will occur immediately after all in