<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252">
</head>
<body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; color: rgb(0, 0, 0); font-size: 14px; font-family: Calibri, sans-serif;">
<div>
<div>Thanks Steve, that’s exactly what I wanted to know!</div>
<div><br>
</div>
<div>—ruby</div>
</div>
<div></div>
<div><br>
</div>
<span id="OLK_SRC_BODY_SECTION">
<div style="font-family:Calibri; font-size:12pt; text-align:left; color:black; BORDER-BOTTOM: medium none; BORDER-LEFT: medium none; PADDING-BOTTOM: 0in; PADDING-LEFT: 0in; PADDING-RIGHT: 0in; BORDER-TOP: #b5c4df 1pt solid; BORDER-RIGHT: medium none; PADDING-TOP: 3pt">
<span style="font-weight:bold">From: </span>Steve Martinelli <<a href="mailto:s.martinelli@gmail.com">s.martinelli@gmail.com</a>><br>
<span style="font-weight:bold">Reply-To: </span>"OpenStack Development Mailing List (not for usage questions)" <<a href="mailto:openstack-dev@lists.openstack.org">openstack-dev@lists.openstack.org</a>><br>
<span style="font-weight:bold">Date: </span>Thursday, May 12, 2016 at 12:05 PM<br>
<span style="font-weight:bold">To: </span>"OpenStack Development Mailing List (not for usage questions)" <<a href="mailto:openstack-dev@lists.openstack.org">openstack-dev@lists.openstack.org</a>><br>
<span style="font-weight:bold">Subject: </span>Re: [openstack-dev] [ironic][openstackclient] deprecation process<br>
</div>
<div><br>
</div>
<span style="mso-bookmark:_MailOriginalBody">
<div>
<div>
<div dir="ltr">I thought we had this written down somewhere but I can't find it. The OSC deprecation process is two major releases. So if something was deprecated in L, it is removed in N. This goes for optional parameters being renamed / dropped, or commands
being dropped / renamed.
<div><br>
</div>
<div>If an optional parameter is being deprecated (say --tenant in favor of --project), then we usually add a mutually exclusive group for these, and force the user to only pick one, log a deprecation message if they pick the wrong one, and suppress the help
text of the old option. See [1] for an example</div>
<div><br>
</div>
<div>If a command is being deprecated it's a bit easier, just log a deprecation message and remove it. If it is being renamed then you can also have it subclass the new command.</div>
<div><br>
</div>
<div>As always, the deprecation message should indicate which command / option to use. </div>
<div><br>
</div>
<div>[1] <a href="https://github.com/openstack/python-openstackclient/blob/b4c3adbd308e65679489c4c64680cbe0324f4bc7/openstackclient/volume/v1/volume.py#L53-L63">https://github.com/openstack/python-openstackclient/blob/b4c3adbd308e65679489c4c64680cbe0324f4bc7/openstackclient/volume/v1/volume.py#L53-L63</a></div>
</div>
<div class="gmail_extra"><br>
<div class="gmail_quote">On Thu, May 12, 2016 at 9:46 AM, Loo, Ruby <span dir="ltr">
<<a href="mailto:ruby.loo@intel.com" target="_blank">ruby.loo@intel.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div style="word-wrap:break-word;color:rgb(0,0,0);font-size:14px;font-family:Calibri,sans-serif">
<div>Hi OpenStackClient folks,</div>
<div><br>
</div>
<div>Ironic is following the standard deprecation process [1]. We added an OSC plugin and realized that we didn’t get the commands quite right. This patch [2] adds the right commands and deprecates the wrong ones. My question is what the deprecation process
might be. Since it is a plugin to OSC, should it follow OSC’s deprecation process and if so, what might that process be? Or since the commands are related to ironic, should it follow ironic’s deprecation process? In particular, I wanted to know how long should/must
we support those deprecated commands.</div>
<div><br>
</div>
<div>For the user’s sake, it seems like it would make sense that all OSC (plugin or not, does the user know the difference?) commands follow the same deprecation policy.</div>
<div><br>
</div>
<div>I took a quick look and didn’t see anything documented about this, so I might have missed it. </div>
<div><br>
</div>
<div>What sez you?</div>
<div><br>
</div>
<div>—ruby</div>
<div><br>
</div>
<div>
<div>[1] <a href="https://governance.openstack.org/reference/tags/assert_follows-standard-deprecation.html" target="_blank">https://governance.openstack.org/reference/tags/assert_follows-standard-deprecation.html</a></div>
<div></div>
<div>[2] <a href="https://review.openstack.org/#/c/284160" target="_blank">https://review.openstack.org/#/c/284160</a></div>
</div>
<div><br>
</div>
<div>
<div></div>
</div>
</div>
<br>
__________________________________________________________________________<br>
OpenStack Development Mailing List (not for usage questions)<br>
Unsubscribe: <a href="http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe" rel="noreferrer" target="_blank">
OpenStack-dev-request@lists.openstack.org?subject:unsubscribe</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
<br>
</blockquote>
</div>
<br>
</div>
</div>
</div>
</span></span>
</body>
</html>