Skip to content

Commit ed6c9ef

Browse files
committed
config: Explicily make consoleSize unspecified if terminal is false or unset
The old language is from a502caf (config: Add consoleSize to process, 2016-09-14, #563), where nobody commented on the "if attached" wording [1]. But reading the old line now, it's not clear to me what consoleSize means when terminal is not true. This commit explicitly declares consoleSize ignored in that condition. I'd rather have made it unspecified, so runtimes are free to do what they want short of erroring out, but Michael wanted the more specific "ignored" [2]. I considered making the property undefined or requiring it to be unset, but those seemed too strict given our permissive "MUST ignore unknown properties" extensibility requirement. [1]: #563 [2]: #863 (comment) Signed-off-by: W. Trevor King <[email protected]>
1 parent f79b61d commit ed6c9ef

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

config.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,8 @@ For all platform-specific configuration values, the scope defined below in the [
137137

138138
* **`terminal`** (bool, OPTIONAL) specifies whether a terminal is attached to that process, defaults to false.
139139
As an example, if set to true 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].
140-
* **`consoleSize`** (object, OPTIONAL) specifies the console size in characters of the terminal if attached, containing the following properties:
140+
* **`consoleSize`** (object, OPTIONAL) specifies the console size in characters of the terminal.
141+
Runtimes MUST ignore `consoleSize` if `terminal` is `false` or unset.
141142
* **`height`** (uint, REQUIRED)
142143
* **`width`** (uint, REQUIRED)
143144
* **`cwd`** (string, REQUIRED) is the working directory that will be set for the executable.

0 commit comments

Comments
 (0)