openstack/devstack
Code Issues Proposed changes

Clarify new header configuration syntax

Browse Source 
Make it clear that there are no spaces in the
new header section.

Change-Id: I69c14017820621a3aea75e41960ac3758f7e4835
This commit is contained in:
dieterly 2015-09-18 15:10:48 -06:00
parent 624ab1e65d
commit 7c7679ecc9
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/configuration.rst
View File

@ -18,11 +18,12 @@ A sample is provided in ``devstack/samples``
The new header is similar to a normal INI section header but with double
brackets (``[[ ... ]]``) and two internal fields separated by a pipe
(``|``):
(``|``). Note that there are no spaces between the double brackets and the
internal fields. Likewise, there are no spaces between the pipe and the
internal fields:
::
[[ <phase> | <config-file-name> ]]
'[[' <phase> '|' <config-file-name> ']]'
where ``<phase>`` is one of a set of phase names defined by ``stack.sh``
and ``<config-file-name>`` is the configuration filename. The filename