Tick-tock usage of GZ_TRANSPORT_LOG_SQL_PATH

Signed-off-by: methylDragon <methylDragon@gmail.com>
gazebosim · May 26, 2022 · e3daa00 · e3daa00
1 parent 7887884
commit e3daa00
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/log/include/gz/transport/log/Log.hh b/log/include/gz/transport/log/Log.hh
@@ -41,6 +41,9 @@ namespace gz
       /// \brief Name of Environment variable containing path to schema
       const std::string SchemaLocationEnvVar = "GZ_TRANSPORT_LOG_SQL_PATH";
 
+      // TODO(CH3): Deprecated. Remove this on ticktock.
+      const std::string SchemaLocationEnvVarDeprecated = "IGN_TRANSPORT_LOG_SQL_PATH";
+
       /// \brief Interface to a log file
       class GZ_TRANSPORT_LOG_VISIBLE Log
       {

diff --git a/log/src/Log.cc b/log/src/Log.cc
@@ -444,6 +444,20 @@ bool Log::Open(const std::string &_file, const std::ios_base::openmode _mode)
     // Test hook so tests can be run before `make install`
     std::string schemaFile;
     const char *envPath = std::getenv(SchemaLocationEnvVar.c_str());
+
+    // TODO(CH3): Deprecated. Remove this on ticktock.
+    if (!(envPath))
+    {
+      envPath = std::getenv(SchemaLocationEnvVarDeprecated.c_str());
+
+      if ((envPath))
+      {
+        LWRN("Found schema using deprecated environment variable ["
+             << SchemaLocationEnvVarDeprecated.c_str()
+             << "]. Please use [" << SchemaLocationEnvVar.c_str() << "] instead.")
+      }
+    }
+
     if (envPath)
     {
       schemaFile = envPath;