From bb0b43eae854125688f3143e53c8974cafed4ad2 Mon Sep 17 00:00:00 2001
From: Rickard Green <rickard@erlang.org>
Date: Wed, 6 Sep 2017 17:00:14 +0200
Subject: Don't allow null chars in various strings

Various places that now reject null chars inside strings
- Primitive file operations reject it in filenames.
- Primitive environment variable operations reject it in
  names and values.
- os:cmd() reject it in its input.

Also '=' characters are rejected by primitive environment
variable operations in environment variable names.

Documentation has been updated to document null characters
in these types of data as invalid. Currently these operations
accept null chars at the end of strings, but that will change
in the future.
---
 erts/doc/src/erlang.xml | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

(limited to 'erts/doc/src/erlang.xml')

diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
index 2465f49581..aa24eeedd5 100644
--- a/erts/doc/src/erlang.xml
+++ b/erts/doc/src/erlang.xml
@@ -3683,6 +3683,12 @@ RealSystem = system + MissedSystem</code>
           </item>
           <tag><c>{env, <anno>Env</anno>}</c></tag>
           <item>
+	    <p>
+	      Types:<br/>
+	      &nbsp;&nbsp;<c><anno>Name</anno> = </c><seealso marker="kernel:os#type-env_var_name"><c>os:env_var_name()</c></seealso><br/>
+	      &nbsp;&nbsp;<c><anno>Val</anno> = </c><seealso marker="kernel:os#type-env_var_value"><c>os:env_var_value()</c></seealso><c> | false</c><br/>
+	      &nbsp;&nbsp;<c>Env = [{<anno>Name</anno>, <anno>Val</anno>}]</c>
+	    </p>
             <p>Only valid for <c>{spawn, <anno>Command</anno>}</c>, and
               <c>{spawn_executable, <anno>FileName</anno>}</c>.
               The environment of the started process is extended using
@@ -3697,7 +3703,13 @@ RealSystem = system + MissedSystem</code>
               exception is <c><anno>Val</anno></c> being the atom
               <c>false</c> (in analogy with
               <seealso marker="kernel:os#getenv/1"><c>os:getenv/1</c></seealso>,
-              which removes the environment variable.</p>
+              which removes the environment variable.
+	    </p>
+	    <p>
+	      For information about encoding requirements, see documentation
+	      of the types for <c><anno>Name</anno></c> and
+	      <c><anno>Val</anno></c>.
+	    </p>
           </item>
           <tag><c>{args, [ string() | binary() ]}</c></tag>
           <item>
-- 
cgit v1.2.3