From 1f98fbb1fc32576937fa4c3bf9e329618de34f59 Mon Sep 17 00:00:00 2001 From: KATO Tomoyuki Date: Sun, 29 May 2016 11:40:59 +0900 Subject: [PATCH] [config-ref] add README for diff_branches.py Change-Id: I2c18ecb92e8b15378420c96b87c7c9671a4b1469 --- autogenerate_config_docs/README.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/autogenerate_config_docs/README.rst b/autogenerate_config_docs/README.rst index 0eb362d8..349d0638 100644 --- a/autogenerate_config_docs/README.rst +++ b/autogenerate_config_docs/README.rst @@ -27,7 +27,7 @@ packages. For Ubuntu install the required packages with the following command: libjpeg-dev liberasurecode-dev -.. note: +.. note:: * libjpeg is needed for ironic * 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 the various configuration files and sections. Most of the options must be 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