Skip to content

Commit 52f3cde

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

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

config-linux.md

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

config.md

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

9595
**`process`** (object, REQUIRED) configures the container process.
9696

97-
* **`terminal`** (bool, OPTIONAL) specifies whether you want a terminal attached to that process, defaults to false.
97+
* **`terminal`** (bool, optional) specifies whether a terminal is attached to that process, defaults to false.
98+
On Linux, a pseudoterminal pair is allocated for the container process and the pseudoterminal slave is duplicated on the container process's [standard streams][stdin.3].
9899
* **`consoleSize`** (object, OPTIONAL) specifies the console size of the terminal if attached, containing the following properties:
99100
* **`height`** (uint, REQUIRED)
100101
* **`width`** (uint, REQUIRED)
@@ -744,3 +745,4 @@ Here is a full example `config.json` for reference.
744745
[mount.8-filesystem-independent]: http://man7.org/linux/man-pages/man8/mount.8.html#FILESYSTEM-INDEPENDENT_MOUNT%20OPTIONS
745746
[mount.8-filesystem-specific]: http://man7.org/linux/man-pages/man8/mount.8.html#FILESYSTEM-SPECIFIC_MOUNT%20OPTIONS
746747
[mount.8]: http://man7.org/linux/man-pages/man8/mount.8.html
748+
[stdin.3]: http://man7.org/linux/man-pages/man3/stdin.3.html

0 commit comments

Comments
 (0)