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
Add a definition list under the help text to detail pertinent flags.
Make 'mutable' one of these flags.
Change-Id: Idc0080be25db12485b33be421c5557d78418823c
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
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
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
If the flagmappings file doesn't exist the function will create it,
with all the sections set to Unknown. This mimics the behavior of the
`create`, not needed anymore.
Change-Id: I7a920300b784aa8fca6412c292d807beb4d5c8e5
Update the default paths to make the scripts work after the config-ref
publication.
Implements: blueprint config-ref-rst
Change-Id: I55534d08b10af4fb44a7dd22718ae22e44708559
When a module import fails the wrapper script doesn't display its
path/name, so it is complicated to debug. this patch displays the module
name before re-raising the exception.
Change-Id: Ie9d691a41b0c178b856f19605a8c6434d3ce2c88
We want to be able to change the section in which an option is
registered in the documentation. This patch uses a <project>.overrides
file to define in which section(s) an option should be moved.
The format of this file is (1 line per option):
[<group>/]<option> <new_group1>[ <new_group2> ... ]
Change-Id: I9fd0b763b6e56cd360694566de7f3acc3172c9c1
Closes-Bug: #1522794
Each table need to be markuped up for reference.
In case the label is set at outside of inclusion,
Sphinx can not properly treat the label.
Change-Id: I2257471300ca5752ba717858a14d4fa26f62916f
Multiple lines means dealing with indentation, which is complicated and
not a problem for automatically generated tables. Use the same helptext
generation in autohelp than in extract_swift_flags.
Change-Id: Ibd64d3f0387c3e7f1f3aacf57be5f0c97addf5c9
This is just for update package list changes.
Not solved config reference autogeneration problem.
Remove stackforge package handling in autohelp-wrapper
Remove modules
networking-ibm (SDNVE) (It seems no maintained)
networking-bigswitch (It seems no maintained)
networking-portforwarding (It seems no maintained)
Changes from stackforge to openstack
networking-bagpipe-l2, networking-brocade,
networking-edge-vpn, networking-hyperv,
networking-mlnx, networking-nec, networking-ovs-dpdk,
networking-zvm, networking-6wind
Add
octavia
Change-Id: I5ba3b26e110f55b2cc76f37b903a1b07dd6a1202
Related-Bug: #1503967
Autogenerate-config-docs creates files that live in the
openstack-manuals repository, but are automatically generated
and should not be edited.
On occasion, contributors miss the warning not to edit the files.
This patch increases the previous warning so that it should take up
enough screen real-estate in a text editor that it would be less
easily skipped, and adds some additional information on what to do
instead.
Change-Id: I800e1ed19427e00f903046731fe8f22f22e4c6db
With this patch, it can run on
designate
manila
zaqar
Related-Bug: #1407581
How to add
see the Trace back and add last item. like follows
For addin designate.api.v1.extensions.sync case,
====log===
Traceback (most recent call last):
snip
File "/home/sakaia/work/openstack-doc-tools/autogenerate_config_docs/autohelp.py", line 138, in import_modules
module = importlib.import_module(modname)
File "/usr/lib/python2.7/importlib/__init__.py", line 37, in import_module
__import__(name)
File "/home/sakaia/work/openstack-doc-tools/autogenerate_config_docs/sources/designate/designate/api/v1/extensions/sync.py", line 23, in <module>
central_api = central_rpcapi.CentralAPI()
=====
Change-Id: I76101cba32c4dd09a303a878719db5f544eb3ebf
This change modifies the -i option behavior of autohelp.py to add the
possibility to find configuration options in multiple repositories. The
change implies a few related modifications:
- do not check if the source repository is a git repository
- update autohelp-wrapper to clone and use the additional repositories
(only for neutron at the moment)
Note: diff_branches.py will not work with this change, it'll be fixed in
another patch.
Closes-Bug: #1448107
Change-Id: I4999aca4f7926e19513acdf38f1e2828b52cee13
All the projects use oslo.i18n in kilo and liberty, the workaround for
projects non using this module is not needed anymore.
Change-Id: I7a096c11eef2ae2f3e9006fa0379f49f18a1cc81
autohelp's OptionsCache.load_extension_options() loads options from
libraries. An oslo_config.cfg.Opt object has a 'name' attribute and
a 'dest' attribute. The option name that we're interested in (that
the user sets) is the 'dest' value, not the 'name' value. The
load_extension_options() method was incorrectly using the option's
'name' attribute.
This fixes it so that the option's 'dest' attribute is used instead.
Eg, from oslo_log library, it now correctly uses 'log_config_append'
instead of 'log-config-append'.
Change-Id: I01422bf33be286cc0176a3e1e4ac1c348c6821ef
Closes-Bug: #1464058
We are mmoving the guides to RST, so we need config-reference tables in
this format. This patch adds a `rst` subcommand to autohelp.py to handle
this new requirement.
RST has limited tables-related features, and openstackdocstheme will
need an update to improve the output.
Change-Id: I5e58d60e2308d208e850f903559da5f5a6a949e3
The Oslo libraries have moved all of their code out of the 'oslo'
namespace package into per-library packages. The namespace package was
retained during kilo for backwards compatibility, but will be removed by
the liberty-2 milestone. This change removes the use of the namespace
package, replacing it with the new package names.
The patches in the libraries will be put on hold until application
patches have landed, or L2, whichever comes first. At that point, new
versions of the libraries without namespace packages will be released as
a major version update.
Please merge this patch, or an equivalent, before L2 to avoid problems
with those library releases.
Blueprint: remove-namespace-packages
https://blueprints.launchpad.net/oslo-incubator/+spec/remove-namespace-packages
Change-Id: Ib17a74ada3122ce45c52fdd7dcf8d27fafbb1d70
Using oslo.config objects in pickle leads to multiple import problems on
deserialization. Since we don't actually need oslo objects, we convert
them into dicts before dumping them.
Change-Id: Icbd1a3957e4d4ae05fe6227fbdd1cb58e5a3a98d
These folders used to bring command line options that we don't want to
have in the generated tables, but the behavior has changed. This patch
restores the import of files in the cmd/ folders, and handles special
cases where the import is problematic.
Change-Id: I0779e0f689d2f6f64149c3d111a8dd1ecd6cfc20
Partial-Bug: #1363954
Specifying the encoding and working with unicode strings in not
supported in lxml. The BASE_XML string is only used to init the XML tree
and does not need a specific encoding. The utf-8 encoding is explicitely
added when the final XML is written to file.
Change-Id: I74e0a316cf718ad9768a690f8ccc4a1cc9a9fc7e
We use trickery to import the keystone middleware options, which might
result in duplicated opts errors. This patch ignore such errors on the
middleware import.
Also use keystonemiddleware instead of keystoneclient.middleware.
Change-Id: I4e003ec9f4a7a706a2bbdeea5f874624fc59ea40
A previous patch attempted to introduce semantic tagging for
options and their default values in the automatically
generated configuration reference tables.
While this worked well for swift, incorrect code was used
for the XML generation of the main autohelp.py method.
This patch fixes the string based code to use XML subElements
as was already done for extract_swift_flags.
Change-Id: I93a89b726d66acd0778e8365f47d5ee2f2e0b3c5
