Skip to content

Commit 184d182

Browse files
wkingMa Shimiao
authored andcommitted
config: Consistent Markdown/Go wording for 'mounts'
I've replaced the old MAY with our usual (<type>, <optional|required>) to get the property name first, since that translates more directly into a Go comment that godoc will like. Signed-off-by: W. Trevor King <[email protected]>
1 parent 9386b67 commit 184d182

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

config.md

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

4040
## Mounts
4141

42-
You MAY add array of mount points inside container as `mounts`.
42+
**`mounts`** (array, optional) configures additional mounts (on top of [`root`](#root-configuration)).
4343
The runtime MUST mount entries in the listed order.
4444
The parameters are similar to the ones in [the Linux mount system call](http://man7.org/linux/man-pages/man2/mount.2.html).
4545

specs-go/config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ type Spec struct {
1414
Root Root `json:"root"`
1515
// Hostname configures the container's hostname.
1616
Hostname string `json:"hostname,omitempty"`
17-
// Mounts profile configuration for adding mounts to the container's filesystem.
17+
// Mounts configures additional mounts (on top of Root).
1818
Mounts []Mount `json:"mounts,omitempty"`
1919
// Hooks are the commands run at various lifecycle events of the container.
2020
Hooks Hooks `json:"hooks"`

0 commit comments

Comments
 (0)