Add warning about REZ_LOG_DEPRECATION_WARNINGS forcefully loading all…

… configs Signed-off-by: Jean-Christophe Morin <[email protected]>
AcademySoftwareFoundation · Nov 18, 2023 · 427c3a4 · 427c3a4
1 parent 334d1d6
commit 427c3a4
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,13 @@ Probably the last release before 3.0.0
 Rez installations now only support Python 3.7+. It is important to note that the API
 can still be used with Python 2.7+ but this will be dropped in 3.0.0
 
+### Features
+
+* New environment variable `REZ_LOG_DEPRECATION_WARNINGS` that will force
+  all deprecation warnings to be printed, ignoring `PYTHONWARNINGS` and custom
+  warning filters. Note that enabling this will forcefully load every
+  configuration file instead of loading them lazilly.
+
 ### Deprecations
 
 We decided to deprecated some things that have been "deprecated" for a while but were never

diff --git a/docs/source/environment.rst b/docs/source/environment.rst
@@ -263,6 +263,11 @@ Development Environment Variables
    Prior to updating, you should set this environment variable to see if you need to
    change some things to be compatible with newer versions.
 
+   .. warning::
+
+      Enabling this will forcefully load every configuration file instead of loading them
+      lazilly. This can have an impact on startup time.
+
 .. envvar:: REZ_SIGUSR1_ACTION
 
    If you set this to ``print_stack``, rez will prints its