Skip to content

Commit

Permalink
config: Consistent Markdown/Go/JSON-Schema wording for 'root'
Browse files Browse the repository at this point in the history
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 <wking@tremily.us>
  • Loading branch information
wking committed Aug 3, 2016
1 parent 9500be8 commit d7b8877
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion config.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ For example, if an implementation is compliant with version 1.0.1 of the spec, i

## Root Configuration

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

* **`path`** (string, required) Specifies the path to the root filesystem for the container.
A directory MUST exist at the path declared by the field.
Expand Down
2 changes: 1 addition & 1 deletion schema/config-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
}
},
"root": {
"description": "The path to the root filesystem for the container.",
"description": "Configures the container's root filesystem.",
"id": "https://opencontainers.org/schema/bundle/root",
"type": "object",
"properties": {
Expand Down
2 changes: 1 addition & 1 deletion specs-go/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ type Spec struct {
Platform Platform `json:"platform"`
// Process configures the container process.
Process Process `json:"process"`
// Root is the root information for the container's filesystem.
// Root configures the container's root filesystem.
Root Root `json:"root"`
// Hostname is the container's host name.
Hostname string `json:"hostname,omitempty"`
Expand Down

0 comments on commit d7b8877

Please sign in to comment.