[Openstack] documentation of flags, introducing of a naming convention for flags

Christian Berendt berendt at b1-systems.de
Tue Feb 22 06:37:22 UTC 2011


Hi.

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

example:

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 at b1-systems.de

B1 Systems GmbH
Osterfeldstra├če 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 198 bytes
Desc: not available
URL: <http://lists.openstack.org/pipermail/openstack/attachments/20110222/f9da4d3d/attachment.sig>


More information about the Openstack mailing list