Document DictOpt class
There was confusion caused by the name of the class itself, so let's document how the configuration is actually specified in the config file Closes-Bug: #1413389 Change-Id: I1b8e2efc7ef76afb0c2bfeb6fe9455f63e4a28a2
This commit is contained in:
parent
20f57378ec
commit
046be3b1fd
|
@ -266,6 +266,24 @@ log files::
|
|||
...
|
||||
]
|
||||
|
||||
Dictionary Options
|
||||
------------------
|
||||
|
||||
If you need end users to specify a dictionary of key/value pairs, then you can
|
||||
use the DictOpt::
|
||||
|
||||
opts = [
|
||||
cfg.DictOpt('foo',
|
||||
default={}))
|
||||
]
|
||||
|
||||
The end users can then specify the option foo in their configuration file
|
||||
as shown below::
|
||||
|
||||
[DEFAULT]
|
||||
foo = k1:v1,k2:v2
|
||||
|
||||
|
||||
Global ConfigOpts
|
||||
-----------------
|
||||
|
||||
|
|
Loading…
Reference in New Issue