Skip to content

Commit 7858d03

Browse files
author
Ma Shimiao
committed
consistency and style fix
replace file sytem with filesystem for consistent in context keep one sentence per line Signed-off-by: Ma Shimiao <[email protected]>
1 parent ce6011c commit 7858d03

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

config.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,14 @@ For Windows, see [mountvol][mountvol] and [SetVolumeMountPoint][set-volume-mount
5858
* Solaris: corresponds to "dir" of the fs resource in [zonecfg(1M)][zonecfg.1m].
5959
* **`type`** (string, OPTIONAL) The filesystem type of the filesystem to be mounted.
6060
* Linux: valid *filesystemtype* supported by the kernel as listed in */proc/filesystems* (e.g., "minix", "ext2", "ext3", "jfs", "xfs", "reiserfs", "msdos", "proc", "nfs", "iso9660").
61-
* Windows: the type of file system on the volume, e.g. "ntfs".
61+
* Windows: the type of filesystem on the volume, e.g. "ntfs".
6262
* Solaris: corresponds to "type" of the fs resource in [zonecfg(1M)][zonecfg.1m].
6363
* **`source`** (string, OPTIONAL) A device name, but can also be a directory name or a dummy.
6464
* Windows: the volume name that is the target of the mount point, \\?\Volume\{GUID}\ (on Windows source is called target).
6565
* Solaris: corresponds to "special" of the fs resource in [zonecfg(1M)][zonecfg.1m].
6666
* **`options`** (list of strings, OPTIONAL) Mount options of the filesystem to be used.
67-
* Linux: supported options are listed in the [mount(8)][mount.8] man page. Note both [filesystem-independent][mount.8-filesystem-independent] and [filesystem-specific][mount.8-filesystem-specific] options are listed.
67+
* Linux: supported options are listed in the [mount(8)][mount.8] man page.
68+
Note both [filesystem-independent][mount.8-filesystem-independent] and [filesystem-specific][mount.8-filesystem-specific] options are listed.
6869
* Solaris: corresponds to "options" of the fs resource in [zonecfg(1M)][zonecfg.1m].
6970

7071
### Example (Linux)
@@ -132,8 +133,11 @@ For Windows, see [mountvol][mountvol] and [SetVolumeMountPoint][set-volume-mount
132133
* **`env`** (array of strings, OPTIONAL) with the same semantics as [IEEE Std 1003.1-2001's `environ`][ieee-1003.1-2001-xbd-c8.1].
133134
* **`args`** (array of strings, REQUIRED) with similar semantics to [IEEE Std 1003.1-2001 `execvp`'s *argv*][ieee-1003.1-2001-xsh-exec].
134135
This specification extends the IEEE standard in that at least one entry is REQUIRED, and that entry is used with the same semantics as `execvp`'s *file*.
135-
* **`capabilities`** (object, OPTIONAL) is an object containing arrays that specifies the sets of capabilities for the process(es) inside the container. Valid values are platform-specific. For example, valid values for Linux are defined in the [capabilities(7)][capabilities.7] man page, such as `CAP_CHOWN`. Any value which cannot be mapped to a relevant kernel interface MUST cause an error.
136-
capabilities contains the following properties:
136+
* **`capabilities`** (object, OPTIONAL) is an object containing arrays that specifies the sets of capabilities for the process(es) inside the container.
137+
Valid values are platform-specific.
138+
For example, valid values for Linux are defined in the [capabilities(7)][capabilities.7] man page, such as `CAP_CHOWN`.
139+
Any value which cannot be mapped to a relevant kernel interface MUST cause an error.
140+
`capabilities` contains the following properties:
137141
* **`effective`** (array of strings, OPTIONAL) - the `effective` field is an array of effective capabilities that are kept for the process.
138142
* **`bounding`** (array of strings, OPTIONAL) - the `bounding` field is an array of bounding capabilities that are kept for the process.
139143
* **`inheritable`** (array of strings, OPTIONAL) - the `inheritable` field is an array of inheritable capabilities that are kept for the process.
@@ -144,7 +148,8 @@ For Windows, see [mountvol][mountvol] and [SetVolumeMountPoint][set-volume-mount
144148

145149
* **`type`** (string, REQUIRED) - the platform resource being limited, for example on Linux as defined in the [setrlimit(2)][setrlimit.2] man page.
146150
* **`soft`** (uint64, REQUIRED) - the value of the limit enforced for the corresponding resource.
147-
* **`hard`** (uint64, REQUIRED) - the ceiling for the soft limit that could be set by an unprivileged process. Only a privileged process (e.g. under Linux: one with the CAP_SYS_RESOURCE capability) can raise a hard limit.
151+
* **`hard`** (uint64, REQUIRED) - the ceiling for the soft limit that could be set by an unprivileged process.
152+
Only a privileged process (e.g. under Linux: one with the CAP_SYS_RESOURCE capability) can raise a hard limit.
148153

149154
If `rlimits` contains duplicated entries with same `type`, the runtime MUST error out.
150155

@@ -174,7 +179,7 @@ For Linux and Solaris based systems the user structure has the following fields:
174179

175180
* **`uid`** (int, REQUIRED) specifies the user ID in the [container namespace](glossary.md#container-namespace).
176181
* **`gid`** (int, REQUIRED) specifies the group ID in the [container namespace](glossary.md#container-namespace).
177-
* **`additionalGids`** (array of ints, OPTIONAL) specifies additional group IDs (in the [container namespace](glossary.md#container-namespace) to be added to the process.
182+
* **`additionalGids`** (array of ints, OPTIONAL) specifies additional group IDs in the [container namespace](glossary.md#container-namespace) to be added to the process.
178183

179184
_Note: symbolic name for uid and gid, such as uname and gname respectively, are left to upper levels to derive (i.e. `/etc/passwd` parsing, NSS, etc)_
180185

@@ -302,13 +307,13 @@ For Windows based systems the user structure has the following fields:
302307

303308
**`platform`** (object, REQUIRED) specifies the configuration's target platform.
304309

305-
* **`os`** (string, REQUIRED) specifies the operating system family of the container configuration's specified [`root`](#root) file system bundle.
310+
* **`os`** (string, REQUIRED) specifies the operating system family of the container configuration's specified [`root`](#root) filesystem bundle.
306311
The runtime MUST generate an error if it does not support the specified **`os`**.
307-
Bundles SHOULD use, and runtimes SHOULD understand, **`os`** entries listed in the Go Language document for [`GOOS`][go-environment].
312+
This value SHOULD use, and runtimes SHOULD understand, **`os`** entries listed in the Go Language document for [`GOOS`][go-environment].
308313
If an operating system is not included in the `GOOS` documentation, it SHOULD be submitted to this specification for standardization.
309-
* **`arch`** (string, REQUIRED) specifies the instruction set for which the binaries in the specified [`root`](#root) file system bundle have been compiled.
314+
* **`arch`** (string, REQUIRED) specifies the instruction set for which the binaries in the specified [`root`](#root) filesystem bundle have been compiled.
310315
The runtime MUST generate an error if it does not support the specified **`arch`**.
311-
Values for **`arch`** SHOULD use, and runtimes SHOULD understand, **`arch`** entries listed in the Go Language document for [`GOARCH`][go-environment].
316+
This value SHOULD use, and runtimes SHOULD understand, **`arch`** entries listed in the Go Language document for [`GOARCH`][go-environment].
312317
If an architecture is not included in the `GOARCH` documentation, it SHOULD be submitted to this specification for standardization.
313318

314319
### Example
@@ -323,7 +328,7 @@ For Windows based systems the user structure has the following fields:
323328
## <a name="configPlatformSpecificConfiguration" />Platform-specific configuration
324329

325330
[**`platform.os`**](#platform) is used to specify platform-specific configuration.
326-
Runtime implementations MAY support any valid values for platform-specific fields as part of this configuration.
331+
Runtimes MAY support any valid values for platform-specific fields as part of this configuration.
327332

328333
* **`linux`** (object, OPTIONAL) [Linux-specific configuration](config-linux.md).
329334
This MAY be set if **`platform.os`** is `linux` and MUST NOT be set otherwise.
@@ -428,7 +433,7 @@ Keys MUST be unique within this map.
428433
Keys MUST NOT be an empty string.
429434
Keys SHOULD be named using a reverse domain notation - e.g. `com.example.myKey`.
430435
Keys using the `org.opencontainers` namespace are reserved and MUST NOT be used by subsequent specifications.
431-
Implementations that are reading/processing this configuration file MUST NOT generate an error if they encounter an unknown annotation key.
436+
Runtimes MUST NOT generate an error if they encounter an unknown annotation key when reading/processing this configuration file.
432437

433438
Values MUST be strings.
434439
Values MAY be an empty string.
@@ -440,12 +445,12 @@ Values MAY be an empty string.
440445
```
441446

442447
## <a name="configExtensibility" />Extensibility
443-
Implementations that are reading/processing this configuration file MUST NOT generate an error if they encounter an unknown property.
448+
Runtimes MUST NOT generate an error if they encounter an unknown property when reading/processing this configruation file.
444449
Instead they MUST ignore unknown properties.
445450

446451
## Valid values
447452

448-
Implementations that are reading/processing this configuration file MUST generate an error when invalid or unsupported values are encountered.
453+
Runtimes MUST generate an error if they encounter invalid or unsupported values when reading/processing this configuration file.
449454
Unless support for a valid value is explicitly required, runtimes MAY choose which subset of the valid values it will support.
450455

451456
## Configuration Schema Example

0 commit comments

Comments
 (0)