[Bf-blender-cvs] [5af75e2333b] master: Cleanup: Update doc string for BLI_getenv

[Ray Molenkamp]

Commit: 5af75e2333b3c568a70d8301e12716e38ae06b6c
Author: Ray Molenkamp
Date:   Thu Sep 10 10:18:32 2020 -0600
Branches: master
https://developer.blender.org/rB5af75e2333b3c568a70d8301e12716e38ae06b6c

Cleanup: Update doc string for BLI_getenv

The reason for this functions existence was poorly documented

===================================================================

M	source/blender/blenlib/intern/path_util.c

===================================================================

diff --git a/source/blender/blenlib/intern/path_util.c b/source/blender/blenlib/intern/path_util.c
index cde4394a8c3..01bd0329f58 100644
--- a/source/blender/blenlib/intern/path_util.c
+++ b/source/blender/blenlib/intern/path_util.c
@@ -1299,6 +1299,11 @@ void BLI_setenv_if_new(const char *env, const char *val)
 
 /**
  * Get an env var, result has to be used immediately.
+ *
+ * On windows getenv gets its variables from a static copy of the enviroment variables taken at
+ * process startup, causing it to not pick up on evenironment variables created during runtime.
+ * This function uses an alternative method to get enviroment variables that does pick up on
+ * runtime environment variables.
  */
 const char *BLI_getenv(const char *env)
 {