openstack
/
openstack-doc-tools
Code Issues Proposed changes

[config-ref] add README for diff_branches.py 

Change-Id: I2c18ecb92e8b15378420c96b87c7c9671a4b1469
This commit is contained in:
KATO Tomoyuki 2016-05-29 11:40:59 +09:00
parent 329e410bfd
commit 1f98fbb1fc
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
autogenerate_config_docs/README.rst
View File

@ -27,7 +27,7 @@ packages. For Ubuntu install the required packages with the following command:
libjpeg-dev liberasurecode-dev libjpeg-dev liberasurecode-dev
.. note: .. note::
* libjpeg is needed for ironic * libjpeg is needed for ironic
* liberasurecode-dev is needed for swift * liberasurecode-dev is needed for swift
@ -100,3 +100,13 @@ Swift configuration tables are generated using the ``extract_swift_flags.py``
script. This script doesn't use a mapping file, but organize the tables using script. This script doesn't use a mapping file, but organize the tables using
the various configuration files and sections. Most of the options must be the various configuration files and sections. Most of the options must be
described manually at the moment. described manually at the moment.
Generate configuration difference
---------------------------------
To generate "New, updated, and deprecated options" for each service,
run diff_branches.py. For example:
.. code-block:: console
$ ./diff_branches.py stable/liberty stable/mitaka nova