openstack team mailing list archive
Mailing list archive
Re: documentation of flags, introducing of a naming convention for flags
<can of worms>
Just use optparse/argparse. paste.deploy handles configuration files
already, which is where most "flags" should really be... gflags adds
unneeded complexity for no real gains, IMHO. Swift and Glance do just
fine without gflags, as do the vast majority of Python projects. As
for documentation of program options, the most common practice in the
open source world is to document configuration options in the example
configuration files that ship with your project, and document command
line options "inline" to show up in --help output.
</can of worms>
On Tue, Feb 22, 2011 at 1:37 AM, Christian Berendt
> At the moment we're using a lot of flags spread all over the code.
> a) we should create a useful documentation including all flags
> b) we should introduce a naming convention for new flags and we should
> rename existing flags
> all flags related to default values are starting with "default_", all
> flags related to a path are starting with "path_".
> Looks like most of the flags have good names at the moment, but I think
> we should write it down in the wiki or the developer documentation to
> reduce the possibility of bad names in the future.
> c) if it's possible we should collect all flags in one file
> At the moment the flags are defined in the files where they are used. I
> think it would be nice to have on file, for example nova/flags.py,
> including all flags used all over the code.
> Bye, Christian.
> Christian Berendt
> Linux / Unix Consultant & Developer
> Tel.: +49-171-5542175
> Mail: berendt@xxxxxxxxxxxxx
> B1 Systems GmbH
> Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
> GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537
> Mailing list: https://launchpad.net/~openstack
> Post to : openstack@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~openstack
> More help : https://help.launchpad.net/ListHelp