From b6196f5d47c06e6991cfc7e76db3d588a7797302 Mon Sep 17 00:00:00 2001
From: Patrik Nyblom <pan@erlang.org>
Date: Tue, 14 Aug 2012 15:02:43 +0200
Subject: Add documetation about Unicode in environment

---
 lib/kernel/doc/src/os.xml | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

(limited to 'lib/kernel')

diff --git a/lib/kernel/doc/src/os.xml b/lib/kernel/doc/src/os.xml
index e94119845a..09c525b376 100644
--- a/lib/kernel/doc/src/os.xml
+++ b/lib/kernel/doc/src/os.xml
@@ -80,6 +80,10 @@ DirOut = os:cmd("dir"), % on Win32 platform</code>
           Each environment variable is given as a single string on
           the format <c>"VarName=Value"</c>, where <c>VarName</c> is
           the name of the variable and <c>Value</c> its value.</p>
+	<p>If Unicode file name encoding is in effect (see the <seealso
+	marker="erts:erl#file_name_encoding">erl manual
+	page</seealso>), the strings may contain characters with
+	codepoints > 255.</p>
       </desc>
     </func>
     <func>
@@ -93,6 +97,10 @@ DirOut = os:cmd("dir"), % on Win32 platform</code>
         <p>Returns the <c>Value</c> of the environment variable
           <c>VarName</c>, or <c>false</c> if the environment variable
           is undefined.</p>
+	<p>If Unicode file name encoding is in effect (see the <seealso
+	marker="erts:erl#file_name_encoding">erl manual
+	page</seealso>), the strings (both <c>VarName</c> and
+	<c>Value</c>) may contain characters with codepoints > 255.</p>
       </desc>
     </func>
     <func>
@@ -123,6 +131,13 @@ DirOut = os:cmd("dir"), % on Win32 platform</code>
       <desc>
         <p>Sets a new <c>Value</c> for the environment variable
           <c>VarName</c>.</p>
+	<p>If Unicode filename encoding is in effect (see the <seealso
+	marker="erts:erl#file_name_encoding">erl manual
+	page</seealso>), the strings (both <c>VarName</c> and
+	<c>Value</c>) may contain characters with codepoints > 255.</p>
+	<p>On Unix platforms, the environment will be set using UTF-8 encoding
+	if Unicode file name translation is in effect. On Windows the 
+	environment is set using wide character interfaces.</p>
       </desc>
     </func>
     <func>
-- 
cgit v1.2.3