New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve signaling of deprecated code #171

Open
jsiwek opened this Issue Sep 17, 2018 · 1 comment

Comments

Projects
None yet
1 participant
@jsiwek
Copy link
Member

jsiwek commented Sep 17, 2018

Moved from https://bro-tracker.atlassian.net/browse/BIT-1474

Created by Matthias Vallentin at 2015-09-06T19:42:56.730-0500:

Based on discussion in BIT-1411, we need a better mechanism for deprecating code. In particular, Vern suggested the attribute &deprecate=expr syntax where expr would be an expression that evaluates at the point of use of the deprecated construct and would show the user a hint on how to migrate.

Comment by Vern Paxson at 2015-09-06T19:51:49.476-0500:

One thing to add is the need for some sort of option/context such that users can control when the message about the deprecated variable gets displayed.

Comment by Jon Siwek at 2015-09-08T09:13:35.862-0500:

I had already done "&deprecated" (as part of 2.4 I believe). But don't think I allowed it to be assigned an expression which could contain more info or had a global flag to disable the warnings. (Just trying to provide input on what's already available, but both those ideas do seem like useful features to add).

Comment by Matthias Vallentin at 2015-09-08T20:28:32.036-0500:

Ah, I missed that. That's definitely something we can work with. Let's keep this ticket open for now to track the enhancement with evaluated expressions.

@jsiwek

This comment has been minimized.

Copy link
Member

jsiwek commented Jan 11, 2019

An additional convention to think about adopting is to include in the deprecation warning/expression a reference to the last version number we intend for it to be available (making it easier to audit which deprecated code can actually be removed at any point in time). Applicable to both script-layer and core code deprecations.

@jsiwek jsiwek added this to the 2.7 milestone Jan 11, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment