<div dir="ltr"><br><div class="gmail_extra"><br><br><div class="gmail_quote">On Wed, Jun 25, 2014 at 7:32 PM, Nikhil Manchanda <span dir="ltr"><<a href="mailto:nikhil@manchanda.me" target="_blank">nikhil@manchanda.me</a>></span> wrote:<br>


<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><br>
Hi Anne:<br>
<br>
Thanks for bringing this to our attention! This is definitely something<br>
that we need to fix.<br>
<br>
I've filed <a href="https://bugs.launchpad.net/trove/+bug/1334465" target="_blank">https://bugs.launchpad.net/trove/+bug/1334465</a> to track this<br>
issue, and I'm hoping we'll be able to get to it during juno-2 (or<br>
beginning of juno-3 at the latest).<br>
<br>
Once we've got a patch up, I'll probably run it by some doc folks to<br>
make sure that the help text for the options reads okay. Would<br>
appreciate the feedback here.<br>
<br></blockquote><div><br></div><div>Thanks! I forgot to mention, we do have a style guide for writing config options:</div><div><a href="http://docs.openstack.org/developer/oslo.config/styleguide.html">http://docs.openstack.org/developer/oslo.config/styleguide.html</a><br>

</div><div><br></div><div>Also I failed to mention that the swift options descriptions are pulled from the example config files, so those are what need updating. </div><div><br></div><div>Thanks,</div><div>Anne</div><div>

<br></div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">

Thanks,<br>
Nikhil<br>
<div><div><br>
Anne Gentle writes:<br>
<br>
> Hi swift and trove devs,<br>
> In working on our automation to document the configuration options across<br>
> OpenStack, we uncovered a deficit in both trove and swift configuration<br>
> option descriptions.<br>
><br>
> Here's an example:<br>
> <a href="http://docs.openstack.org/trunk/config-reference/content/container-sync-realms-configuration.html" target="_blank">http://docs.openstack.org/trunk/config-reference/content/container-sync-realms-configuration.html</a><br>



> You'll notice that many of those options do not have help text. We need<br>
> swift developers to fill in those in your code base so we can continue to<br>
> generate this document.<br>
><br>
> Trove devs, we are finding similar gaps in config option information in<br>
> your source code as well. Please make it a priority prior to our automating<br>
> those in the docs.<br>
><br>
> If you have any questions, let us know through the openstack-docs mailing<br>
> list.<br>
> Thanks,<br>
> Anne<br>
</div></div>> _______________________________________________<br>
> OpenStack-dev mailing list<br>
> <a href="mailto:OpenStack-dev@lists.openstack.org" target="_blank">OpenStack-dev@lists.openstack.org</a><br>
> <a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
<br>
_______________________________________________<br>
OpenStack-dev mailing list<br>
<a href="mailto:OpenStack-dev@lists.openstack.org" target="_blank">OpenStack-dev@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
</blockquote></div><br></div></div>