-
Notifications
You must be signed in to change notification settings - Fork 335
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
Properly mark things that are deprecated as deprecated #1562
Properly mark things that are deprecated as deprecated #1562
Conversation
…setting called log_all_deprecation_warnings to help users know when they are using deprecated things. Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
e2eb648
to
02e4958
Compare
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
… a per setting basis Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
63cdda4
to
d3c4e37
Compare
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
d3c4e37
to
bf7c9a4
Compare
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
f3b40cd
to
f2b2f70
Compare
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
f2b2f70
to
60f8a69
Compare
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
f8d3aa1
to
e4b6df4
Compare
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
# | ||
# .. deprecated:: 2.114.0 | ||
# Will be removed in a future release. Additionally, the default will change | ||
# from disabled to enabled in rez 3.0.0. | ||
disable_rez_1_compatibility = False |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I initially wanted to deprecate it and remove it in 3.0.0, but I found out that this would be a little bit too disruptive for our oldest users. Same for rez_1_environment_variables
. rez_1_environment_variables
is even more painful because it's a lot harder to know if packages are actively using these old environment variables or not.
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
Signed-off-by: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com>
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
98fa587
to
334d1d6
Compare
… configs Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
eca3861
into
AcademySoftwareFoundation:main
Relates to #1552
Properly mark things that are deprecated as deprecated and add a new environment variable called
REZ_LOG_DEPRECATION_WARNINGS
to help users know when they are using deprecated things.The new
REZ_LOG_DEPRECATION_WARNINGS
environment variable will hopefully allow our users to move away from deprecated things before they are removed from 3.0.0.With this work, we can now deprecate pretty much anything, including config settings. Deprecation warnings for config settings will print the config file that generated the warning. It also works with config setting environment variables too.
I tried to find a balance between being conservative and progressive:
disable_rez_1_compatibility
will be enabled andrez_1_environment_variables
will be disabled. Users can always override the defaults if they still need the old behavior.I added every deprecation to the change log in preparation of the release (and facilitate reviewing this PR) and I also wrote a transitioning guide for 3.0.0.
Hopefully, everything is clear and our users should find it straightforward and clear.