Skip to content

Commit f4f161f

Browse files
committed
config: Adjust process.env to immediately punt to POSIX
The uppercase letter / digit / underscore restriction is just for "variables used by the utilities in the Shell and Utilities volume of IEEE Std 1003.1-2001". Copying over some POSIX wording and then linking to POSIX didn't seem like much gain. Just point people at POSIX and let them read about the name=value definition, charset suggestions, etc. there. Also link specifically to chapter 8 section 1 (instead of just chapter 8). Rob Dolin had suggested "platform-appropriate" wording [1], but it seems like Visual Studio 2015 supports an environment-variable array with the same semantics [2], and providing an explicit "platform-appropriate" wiggle seems like it's adding useless complication. [1]: http://ircbot.wl.linuxfoundation.org/meetings/opencontainers/2016/opencontainers.2016-05-18-17.01.log.html#l-54 [2]: https://msdn.microsoft.com/en-us/library/431x4c1w.aspx Signed-off-by: W. Trevor King <[email protected]>
1 parent a39be46 commit f4f161f

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

config.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,7 @@ See links for details about [mountvol](http://ss64.com/nt/mountvol.html) and [Se
100100
* **`width`** (uint, REQUIRED)
101101
* **`cwd`** (string, REQUIRED) is the working directory that will be set for the executable.
102102
This value MUST be an absolute path.
103-
* **`env`** (array of strings, OPTIONAL) contains a list of variables that will be set in the process's environment prior to execution.
104-
Elements in the array are specified as Strings in the form "KEY=value".
105-
The left hand side MUST consist solely of letters, digits, and underscores `_` as outlined in [IEEE Std 1003.1-2001](http://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap08.html).
103+
* **`env`** (array of strings, OPTIONAL) with the same semantics as [IEEE Std 1003.1-2001's `environ`][ieee-1003.1-2001-xbd-c8.1].
106104
* **`args`** (array of strings, REQUIRED) executable to launch and any flags as an array.
107105
The executable is the first element and MUST be available at the given path inside of the rootfs.
108106
If the executable path is not an absolute path then the search $PATH is interpreted to find the executable.
@@ -739,6 +737,7 @@ Here is a full example `config.json` for reference.
739737

740738
[container-namespace]: glossary.md#container-namespace
741739
[go-environment]: https://golang.org/doc/install/source#environment
740+
[ieee-1003.1-2001-xbd-c8.1]: http://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap08.html#tag_08_01
742741
[runtime-namespace]: glossary.md#runtime-namespace
743742
[uts-namespace]: http://man7.org/linux/man-pages/man7/namespaces.7.html
744743
[mount.8-filesystem-independent]: http://man7.org/linux/man-pages/man8/mount.8.html#FILESYSTEM-INDEPENDENT_MOUNT%20OPTIONS

0 commit comments

Comments
 (0)