Deprecate env() with two parameters (#653)

Signed-off-by: Carlos Agüero <[email protected]>
gazebosim · Dec 2, 2024 · 0c05864 · 0c05864
1 parent 7cbbe44
commit 0c05864
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 17 deletions.
diff --git a/include/gz/common/Util.hh b/include/gz/common/Util.hh
@@ -208,16 +208,6 @@ namespace gz
       return hash;
     }
 
-    /// \brief Find the environment variable '_name' and return its value.
-    ///
-    /// \TODO(mjcarroll): Deprecate and remove in tick-tock.
-    ///
-    /// \param[in] _name Name of the environment variable.
-    /// \param[out] _value Value if the variable was found.
-    /// \return True if the variable was found or false otherwise.
-    bool GZ_COMMON_VISIBLE env(
-        const std::string &_name, std::string &_value);
-
     /// \brief Find the environment variable '_name' and return its value.
     /// \param[in] _name Name of the environment variable.
     /// \param[out] _value Value if the variable was found.
@@ -226,7 +216,7 @@ namespace gz
     /// \return True if the variable was found or false otherwise.
     bool GZ_COMMON_VISIBLE env(
         const std::string &_name, std::string &_value,
-        bool _allowEmpty);
+        bool _allowEmpty = false);
 
     /// \brief Set the environment variable '_name'.
     ///

diff --git a/src/Util.cc b/src/Util.cc
@@ -349,12 +349,6 @@ common::SystemPaths *common::systemPaths()
   return &GetSystemPaths();
 }
 
-/////////////////////////////////////////////////
-bool common::env(const std::string &_name, std::string &_value)
-{
-  return env(_name, _value, false);
-}
-
 /////////////////////////////////////////////////
 bool common::env(const std::string &_name,
                            std::string &_value,