[openstack-dev] [swift] [trove] Configuration option descriptions

Nikhil Manchanda nikhil at manchanda.me
Thu Jun 26 00:32:13 UTC 2014

Hi Anne:

Thanks for bringing this to our attention! This is definitely something
that we need to fix.

I've filed https://bugs.launchpad.net/trove/+bug/1334465 to track this
issue, and I'm hoping we'll be able to get to it during juno-2 (or
beginning of juno-3 at the latest).

Once we've got a patch up, I'll probably run it by some doc folks to
make sure that the help text for the options reads okay. Would
appreciate the feedback here.


Anne Gentle writes:

> Hi swift and trove devs,
> In working on our automation to document the configuration options across
> OpenStack, we uncovered a deficit in both trove and swift configuration
> option descriptions.
> Here's an example:
> http://docs.openstack.org/trunk/config-reference/content/container-sync-realms-configuration.html
> You'll notice that many of those options do not have help text. We need
> swift developers to fill in those in your code base so we can continue to
> generate this document.
> Trove devs, we are finding similar gaps in config option information in
> your source code as well. Please make it a priority prior to our automating
> those in the docs.
> If you have any questions, let us know through the openstack-docs mailing
> list.
> Thanks,
> Anne
> _______________________________________________
> OpenStack-dev mailing list
> OpenStack-dev at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

More information about the OpenStack-dev mailing list