There is no hooks module available when running the
extract_swift_flags.py locally, so making this import optional.
Change-Id: I65ebacd1e3e4cf66ece0a9fcbbc785d79278e8bb
Not to break the script with the heading and trailing blanks.
It happens at glance with oslo.i18n deprecation messages.
Change-Id: I33ab7a815fc092cef2ed0688b0693c23802b23c6
The common configurations are described in the common
configurations table. The corresponding configutations
at each table are not necessary.
Change-Id: Ied2d03d1c7f71f5712fcf57d4499e127db327b7d
Implements: blueprint config-ref-common-sections
python-pip and python-virtualenv are necessary to run any 'update'
command with autohelp-wrapper, otherwise the script issues a
'command not found' error for pip and virtualenv
Change-Id: I96186764364eaa80a5c73fe6b019b9fd457c57a2
Add a definition list under the help text to detail pertinent flags.
Make 'mutable' one of these flags.
Change-Id: Idc0080be25db12485b33be421c5557d78418823c
The help strings for configuration option are text strings,
not a code item. So, they are not necessary.
Also, it breaks literal markups within the help strings.
Change-Id: I4b9279d5f49a03137d9c1369622fde1ed2df684e
Partial-Bug: #1585927
This is very much a hack, but its really just to see if it is possible
to convert the bullet lists into text that renders correctly with rst.
This was tested with the nova-hyperv.rst:
f0607509e3/doc/config-reference/source/tables/nova-hyperv.rst
Change-Id: Iab063774f6732d52cd8e79f82ff0fc93bd6d306b
Companies may have VPN, and in China, there is a firewall named
G.F.W., they both may block some protocols or ports, so if I run
autohelp-wrapper, it will fail like this:
/opt/stack/openstack-doc-tools/autogenerate_config_docs$ ./autohelp-wrapper update ceilometer
Cloning into '/opt/stack/openstack-doc-tools/autogenerate_config_docs/sources/openstack-manuals'...
fatal: unable to connect to git.openstack.org:
git.openstack.org[0: 104.130.246.128]: errno=Connection timed out
git.openstack.org[1: 2001:4800:7819:103:be76:4eff:fe06:63c]: errno=Network is unreachable
Now we have -g option, which can set GITPROJ, but GITBASE still
use git://git.openstack.org/openstack, so it still fail:
/opt/stack/openstack-doc-tools/autogenerate_config_docs$ ./autohelp-wrapper -g https://github.com/openstack update ceilometer
Here I proposal to use environment variable value for GITPROJ and
GITBASE if they exist, so some devs, like me, can get rid of
hacking autohelp-wrapper to work then restore it when commit.
Change-Id: If7dc3ebe398c71d6461a5983d4aab1bc87984697
Closes-Bug: #1574224
when run ./autohelp-wrapper rst aodh, it failed with:
AttributeError: 'BoolOpt' object has no attribute 'deprecated_reason'
we need to check the value before we use it
Change-Id: I362606ba186d1582f850bfa4d602503d6ea5079a
Closes-Bug: #1573953
Changes to autohelp.py have broken the diff_branches.py script. This
patch fixes the script:
- add a ``dump`` subcommand and a ``-q`` (quiet) option to
autohelp-wrapprt
- use these options in diff_branches.py
- remove the dependency on python-git as it is not needed anymore.
Change-Id: I5d5a7e7141e1a0df1c86d52daae35fe5f33f239b
If a configuration option is tagged as deprecated in the code and the
help text does not start with DEPRECATED: add this to better identify
options that are no longer used.
If the code provides an additional deprecated reason, append this to
the provided help text of the configuration option.
Change-Id: I1a7c76c0109a6e59cc87d0ddc942c6d1cfb9dc91
Update the configuration tables option type from an internal meta type
to a more meaningful description. E.g. Boolean for BoolOpt, String
for StringOpt, Multi-valued for MultiStrOpt etc.
Inspired by the translation used in Developer Docs
Change-Id: I5bd7aec727292ceef4dc0ff56ab8f334ea2f22bc
Running update of keystone produces the following exception which
teminates processing. This enables processing to continue, like
capture of other types of errors.
* Table 'federation_protocol' is already defined for this MetaData
instance. Specify 'extend_existing=True' to redefine options and
columns on an existing Table object.
Cater for projects that do not use sqlalchemy, e.g. swift.
Change-Id: I87df4bb784f94b7194374b2448e4c34beadb923f
Modifying configuration options (ignored modules, extra repositories,
hooks) for autohelp requires an update of the doc-tools repository,
which doesn't make much sense since the goal is to update the manuals
repository.
This patch removes the configuration options from the repository and
updates the scripts to use the configuration items in openstack-manuals.
Change-Id: I630d2a2fea690f6360039aa100331678468d18dc
The flow graph and the tests have not been updated in a long time and
don't match the current state of the autohelp* scripts. Remove them as
they are not used and not accurate.
Change-Id: I6225ac8cfc53564c75fa227d08d2ef6adc661390
