Skip to content

Commit d7b8877

Browse files
committed
config: Consistent Markdown/Go/JSON-Schema wording for 'root'
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 9500be8 commit d7b8877

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ For example, if an implementation is compliant with version 1.0.1 of the spec, i
2222

2323
## Root Configuration
2424

25-
Each container has exactly one *root filesystem*, specified in the *root* object:
25+
**`root`** (object, required) configures the container's root filesystem.
2626

2727
* **`path`** (string, required) Specifies the path to the root filesystem for the container.
2828
A directory MUST exist at the path declared by the field.

schema/config-schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
}
5757
},
5858
"root": {
59-
"description": "The path to the root filesystem for the container.",
59+
"description": "Configures the container's root filesystem.",
6060
"id": "https://opencontainers.org/schema/bundle/root",
6161
"type": "object",
6262
"properties": {

specs-go/config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ type Spec struct {
1010
Platform Platform `json:"platform"`
1111
// Process configures the container process.
1212
Process Process `json:"process"`
13-
// Root is the root information for the container's filesystem.
13+
// Root configures the container's root filesystem.
1414
Root Root `json:"root"`
1515
// Hostname is the container's host name.
1616
Hostname string `json:"hostname,omitempty"`

0 commit comments

Comments
 (0)