<div dir="ltr"><div><div class="gmail_signature"><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><div><div><div><div><div style="font-size:12.8000001907349px">Presently the oslo.config Opt class has the attributes deprecated_for_removal and deprecated_reason [1]</div><div style="font-size:12.8000001907349px"><br></div><div style="font-size:12.8000001907349px">I would like to propose that we use deprecated_reason (at a minimum) to detail in what release an option was deprecated in, and what release it is then removed in.</div><div style="font-size:12.8000001907349px">I see examples of deprecated_for_removal=True but no information on why or when.  i.e. Ideally I'd like to move to an implied situation of  if deprecated_for_removal=True then deprecated_reason is mandatory.</div><div style="font-size:12.8000001907349px"><br></div><div style="font-size:12.8000001907349px">A great example is an already documented help message in oslo.log configuration option use_syslog_rfc_format that at least provides a guideline.  [2] shows a proposed review to take this low road approach.</div><div style="font-size:12.8000001907349px">An image of what the change actually looks like in documentation using this approach [3].  This also needs  #267151 that fixes an issue where deprecated options are not producing a warning message in docs.</div><div style="font-size:12.8000001907349px"><br></div><div style="font-size:12.8000001907349px">The high road would be to have a discussion about if there is a better way to mark and manage deprecated options. For example, if there was a deprecated_release and a removal_release attribute then a level of tooling could make this easier.  I would be wary in considering this, as it adds complexity (is it needed), and just how many options are deprecated.  I'd appreciate thoughts and feedback.</div><div style="font-size:12.8000001907349px"><br></div><div style="font-size:12.8000001907349px">Regards</div><div style="font-size:12.8000001907349px"><br></div><div style="font-size:12.8000001907349px">Ronald</div><div style="font-size:12.8000001907349px"><br></div><div style="font-size:12.8000001907349px"><br></div><div style="font-size:12.8000001907349px">[1] <a href="http://docs.openstack.org/developer/oslo.config/opts.html" target="_blank">http://docs.openstack.org/developer/oslo.config/opts.html</a></div><div style="font-size:12.8000001907349px">[2] <a href="https://review.openstack.org/#/c/267176/" target="_blank">https://review.openstack.org/#/c/267176/</a></div><div style="font-size:12.8000001907349px">[3] <a href="http://postimg.org/image/vdkh3x46t/full/" target="_blank">http://postimg.org/image/vdkh3x46t/full/</a></div></div></div></div></div></div></div></div></div></div></div></div>
</div>