Skip to content

Commit fc103cf

Browse files
committed
config: Consistent Markdown/Go wording for 'process'
I've dropped "main process" because "container process" is currently a much more popular way of identifying that process in this specification. Before this commit: $ git grep -i 'main process' | wc -l 4 $ git grep -i 'container process' | wc -l 13 I've also added our usual: (<type>, <required|optional>) to the Markdown so folks can see that this is a required object. Signed-off-by: W. Trevor King <[email protected]>
1 parent 57fc2ca commit fc103cf

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

config.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,8 @@ See links for details about [mountvol](http://ss64.com/nt/mountvol.html) and [Se
9090

9191
## Process configuration
9292

93+
**`process`** (object, required) configures the container process.
94+
9395
* **`terminal`** (bool, optional) specifies whether you want a terminal attached to that process, defaults to false.
9496
* **`cwd`** (string, required) is the working directory that will be set for the executable.
9597
This value MUST be an absolute path.

specs-go/config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ type Spec struct {
88
Version string `json:"ociVersion"`
99
// Platform specifies the configuration's target platform.
1010
Platform Platform `json:"platform"`
11-
// Process is the container's main process.
11+
// Process configures the container process.
1212
Process Process `json:"process"`
1313
// Root is the root information for the container's filesystem.
1414
Root Root `json:"root"`

0 commit comments

Comments
 (0)