Browse Source

add dsconf help to README

Sean Dague 2 years ago
parent
commit
3997374f8e
1 changed files with 29 additions and 3 deletions
  1. 29
    3
      README.rst

+ 29
- 3
README.rst View File

@@ -4,9 +4,35 @@ devstack-tools
4 4
 
5 5
 Devstack Helper Tools in Python
6 6
 
7
-Please fill here a long description which must be at least 3 lines wrapped on
8
-80 cols, so that distribution package maintainers can use it in their packages.
9
-Note that this is a hard requirement.
7
+This is a set of cli tools for supporting devstack. It moves some of
8
+the complexity out of bash and into python where it's easier to have
9
+comprehensive testing of behavior.
10
+
11
+Currently this includes the ``dsconf`` tool, which provides a cli for
12
+manipulating 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 37
 * Free software: Apache license
12 38
 * Documentation: http://docs.openstack.org/developer/devstack-tools

Loading…
Cancel
Save