summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSean Dague <sean@dague.net>2017-01-18 16:22:46 -0500
committerSean Dague <sean@dague.net>2017-01-18 16:22:46 -0500
commit3997374f8eb6131f723c0b6f5a94a2f4355d5b87 (patch)
tree454956c128871acdbf07f8477ff95a9e79d6fd31
parent2c8054020bec7f43cb4a7de3ac05a87f3b9d0b83 (diff)
add dsconf help to README
-rw-r--r--README.rst32
1 files changed, 29 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index cb13cf4..96a54eb 100644
--- a/README.rst
+++ b/README.rst
@@ -4,9 +4,35 @@ devstack-tools
4 4
5Devstack Helper Tools in Python 5Devstack Helper Tools in Python
6 6
7Please fill here a long description which must be at least 3 lines wrapped on 7This is a set of cli tools for supporting devstack. It moves some of
880 cols, so that distribution package maintainers can use it in their packages. 8the complexity out of bash and into python where it's easier to have
9Note that this is a hard requirement. 9comprehensive testing of behavior.
10
11Currently this includes the ``dsconf`` tool, which provides a cli for
12manipulating local.conf and ini files.
13
14::
15
16 usage: dsconf [-h]
17 {iniset,inicomment,iniuncomment,inirm,extract-localrc,extract,setlc,setlc_conf,merge_lc}
18 ...
19
20 optional arguments:
21 -h, --help show this help message and exit
22
23 commands:
24 {iniset,inicomment,iniuncomment,inirm,extract-localrc,extract,setlc,setlc_conf,merge_lc}
25 sub-command help
26 iniset set item in ini file
27 inicomment comment item in ini file
28 iniuncomment uncomment item in ini file
29 inirm delete item from ini file
30 extract-localrc extract localrc from local.conf
31 extract extract and merge config from local.conf
32 setlc set variable in localrc of local.conf
33 setlc_conf set variable in localrc of local.conf
34 merge_lc merge local.conf files
35
10 36
11* Free software: Apache license 37* Free software: Apache license
12* Documentation: http://docs.openstack.org/developer/devstack-tools 38* Documentation: http://docs.openstack.org/developer/devstack-tools