[Openstack-docs] swift config-ref tables

Gauvain Pocentek gauvain.pocentek at objectif-libre.com
Thu Apr 17 05:24:04 UTC 2014


Le 2014-04-17 04:29, Tom Fifield a écrit :
> On 17/04/14 02:56, Gauvain Pocentek wrote:
>> Hello list,
>> 
>> I'd like to update the swift config-ref tables to include the new
>> settings/helpstrings for icehouse. An extract_swift_flags.py script
>> exists in the openstack-doc-tools repo, but it doesn't seem to work 
>> as I
>> expected it would. From what I understand this script was used only 
>> once
>> to generate the initial tables.
>> 
>> Does anyone (Tom?) have a good knowledge of this script and could 
>> tell
>> me if it is possible to make it generate updated tables?
> 
> Hi,
> 
> If I recall correctly:
> 
> 0. option names and default values are seeded using swift sample files
> 1. Lines in tables/swift*xml are the first source of truth
> 2. Lines in the swift devref are the second source of truth
> 
> So, what happens is - the script will read in all of the existing
> docbook tables, and then try to find options in the devref.
> 
> The algorithm is basicallly
> 
> if it's in the devref, and not in the docbook tables, or the docbook
> tables have "no help text", then add the stuff from the devref to the
> tables. If there's an option in the sample config files, but it's not
> in either place, add it with "no help text".
> 
> Does that make sense?

It does. I ended up with a lot of "no help text" when I ran the script 
yesterday, so something might have changed somewhere. I'll see what I 
can do but I'm afraid that the update will not happen before the 
release...

Thanks Tom,
Gauvain



More information about the Openstack-docs mailing list