Clarify docs for os.getenv.

chrisant996 · Dec 27, 2020 · e797a14 · e797a14
1 parent a0da1a5
commit e797a14
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/clink/lua/src/os_api.cpp b/clink/lua/src/os_api.cpp
@@ -312,6 +312,10 @@ int glob_files(lua_State* state)
 /// -ret:   string | nil
 /// Returns the value of the named environment variable, or nil if it doesn't
 /// exist.
+///
+/// Note that <code>os.getenv("HOME")</code> receives special treatment: if
+/// %HOME% is not set then it is synthesized from %HOMEDRIVE% and %HOMEPATH%, or
+/// from %USERPROFILE%.
 int get_env(lua_State* state)
 {
     const char* name = get_string(state, 1);