Require hacking for additional pep8 checks to follow
OpenStack python hacking conventions.
Fix problems found by hacking.
Disable autogenerate-config-docs from check, it needs further
work to be clean enough.
As discussed on the mailing list, this patch will make the swift
configuration tables found in common a source of truth for the
helptext. The script that generates them has been updated for this,
and will now only add/remove options, update default values, and
replace helptext where it does not exist in the tables. Another
run of the script was done and tables were updated.
Backstory: All projects other than Swift use OpenStack Common for
configuration, and define option, default value and help text in the
code in a way that it's possible to extract.
Since the code is able to act in this way, we can stop maintaining
separate instructive lines for configuration options, and instead
fix any text problems in the code itself. This both improves the
quality of the code and fixes our double maintenance problem.
For swift, we needed a different approach. Unfortunately, I think we
don't have the ability to treat the code as the definitive source and
move all maintenance there. The lack of instruction for every option,
and absence of structure precludes this.
So I wrote some nasty scraping things (from RST and sample conf file)
to seed an initial list of configuration options.
My plan from here was to make the 'update' portion of the script
treat the textual descriptions in common/tables/swift-*.xml as
The script would still search the swift code to add or remove
options, so we could guarantee completeness, and after an initial
push to write out proper help text the maintenance becomes far
This patch re-works swift content for the new configuration reference
The Object Storage configuration section is pared down, with
additional/optional features moved to a new file and section of the
document - adding to what was previously there in the Object Storage
New stub sections added for drive-audit, static web and form post.
One of the big changes is the move of all option tables to
These have been generated with a new script which converts swift
conf files into docbook tables, and attempts to find descriptions
of those configuration options in swift's devref documentation.
Future work for this script: merged in with the autodoc tool
structure, add an 'update' mode.