Skip to content

Commit 0e24a1c

Browse files
committed
Clarify wording for terminal setting and /dev/console
Signed-off-by: Mrunal Patel <[email protected]>
1 parent bbaf29e commit 0e24a1c

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

config-linux.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ In addition to any devices configured with this setting, the runtime MUST also s
147147
* [`/dev/random`][random.4]
148148
* [`/dev/urandom`][random.4]
149149
* [`/dev/tty`][tty.4]
150-
* [`/dev/console`][console.4]
150+
* [`/dev/console`][console.4] is setup if terminal is enabled in the config
151151
* [`/dev/ptmx`][pts.4].
152152
A [bind-mount or symlink of the container's `/dev/pts/ptmx`][devpts].
153153

config.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,8 @@ See links for details about [mountvol](http://ss64.com/nt/mountvol.html) and [Se
8585

8686
## Process configuration
8787

88-
* **`terminal`** (bool, optional) specifies whether you want a terminal attached to that process. Defaults to false.
88+
* **`terminal`** (bool, optional) specifies whether a terminal is attached to that process. Defaults to false.
89+
On Linux, a psuedo-terminal pair is allocated for the container process and the standard streams are duped to the pty slave. Also, the pty slave is bind mounted at /dev/console.
8990
* **`cwd`** (string, required) is the working directory that will be set for the executable. This value MUST be an absolute path.
9091
* **`env`** (array of strings, optional) contains a list of variables that will be set in the process's environment prior to execution. Elements in the array are specified as Strings in the form "KEY=value". 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).
9192
* **`args`** (array of strings, required) executable to launch and any flags as an array. The executable is the first element and MUST be available at the given path inside of the rootfs. If the executable path is not an absolute path then the search $PATH is interpreted to find the executable.

0 commit comments

Comments
 (0)