Skip to content

Commit be3960a

Browse files
author
Mrunal Patel
authored
Merge pull request #811 from Mashimiao/style-consistent-fix
consistency and style fix
2 parents 0239d87 + b92cf90 commit be3960a

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

config.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,8 @@ For all platform-specific configuration values, the scope defined below in the [
7878
* Windows: a local directory on the filesystem of the container host. UNC paths and mapped drives are not supported.
7979
* Solaris: corresponds to "special" of the fs resource in [zonecfg(1M)][zonecfg.1m].
8080
* **`options`** (array of strings, OPTIONAL) Mount options of the filesystem to be used.
81-
* 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.
81+
* Linux: supported options are listed in the [mount(8)][mount.8] man page.
82+
Note both [filesystem-independent][mount.8-filesystem-independent] and [filesystem-specific][mount.8-filesystem-specific] options are listed.
8283
* Solaris: corresponds to "options" of the fs resource in [zonecfg(1M)][zonecfg.1m].
8384

8485
### Example (Linux)
@@ -149,7 +150,7 @@ For all platform-specific configuration values, the scope defined below in the [
149150
Valid values are platform-specific.
150151
For example, valid values for Linux are defined in the [capabilities(7)][capabilities.7] man page, such as `CAP_CHOWN`.
151152
Any value which cannot be mapped to a relevant kernel interface MUST cause an error.
152-
capabilities contains the following properties:
153+
`capabilities` contains the following properties:
153154
* **`effective`** (array of strings, OPTIONAL) - the `effective` field is an array of effective capabilities that are kept for the process.
154155
* **`bounding`** (array of strings, OPTIONAL) - the `bounding` field is an array of bounding capabilities that are kept for the process.
155156
* **`inheritable`** (array of strings, OPTIONAL) - the `inheritable` field is an array of inheritable capabilities that are kept for the process.
@@ -191,7 +192,7 @@ For Linux and Solaris based systems the user structure has the following fields:
191192

192193
* **`uid`** (int, REQUIRED) specifies the user ID in the [container namespace](glossary.md#container-namespace).
193194
* **`gid`** (int, REQUIRED) specifies the group ID in the [container namespace](glossary.md#container-namespace).
194-
* **`additionalGids`** (array of ints, OPTIONAL) specifies additional group IDs (in the [container namespace](glossary.md#container-namespace) to be added to the process.
195+
* **`additionalGids`** (array of ints, OPTIONAL) specifies additional group IDs in the [container namespace](glossary.md#container-namespace) to be added to the process.
195196

196197
_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)_
197198

@@ -319,13 +320,13 @@ For Windows based systems the user structure has the following fields:
319320

320321
**`platform`** (object, REQUIRED) specifies the configuration's target platform.
321322

322-
* **`os`** (string, REQUIRED) specifies the operating system family of the container configuration's specified [`root`](#root) file system bundle.
323+
* **`os`** (string, REQUIRED) specifies the operating system family of the container configuration's specified [`root`](#root) filesystem bundle.
323324
The runtime MUST generate an error if it does not support the specified **`os`**.
324-
Bundles SHOULD use, and runtimes SHOULD understand, **`os`** entries listed in the Go Language document for [`GOOS`][go-environment].
325+
Values SHOULD be, and runtimes SHOULD understand, **`os`** entries listed in the Go Language document for [`GOOS`][go-environment].
325326
If an operating system is not included in the `GOOS` documentation, it SHOULD be submitted to this specification for standardization.
326-
* **`arch`** (string, REQUIRED) specifies the instruction set for which the binaries in the specified [`root`](#root) file system bundle have been compiled.
327+
* **`arch`** (string, REQUIRED) specifies the instruction set for which the binaries in the specified [`root`](#root) filesystem bundle have been compiled.
327328
The runtime MUST generate an error if it does not support the specified **`arch`**.
328-
Values for **`arch`** SHOULD use, and runtimes SHOULD understand, **`arch`** entries listed in the Go Language document for [`GOARCH`][go-environment].
329+
Values SHOULD be, and runtimes SHOULD understand, **`arch`** entries listed in the Go Language document for [`GOARCH`][go-environment].
329330
If an architecture is not included in the `GOARCH` documentation, it SHOULD be submitted to this specification for standardization.
330331

331332
### Example
@@ -456,12 +457,12 @@ Cleanup or debugging functions are examples of such a hook.
456457

457458
## <a name="configExtensibility" />Extensibility
458459

459-
Implementations that are reading/processing this configuration file MUST NOT generate an error if they encounter an unknown property.
460+
Runtimes that are reading or processing this configuration file MUST NOT generate an error if they encounter an unknown property.
460461
Instead they MUST ignore unknown properties.
461462

462463
## Valid values
463464

464-
Implementations that are reading/processing this configuration file MUST generate an error when invalid or unsupported values are encountered.
465+
Runtimes that are reading or processing this configuration file MUST generate an error when invalid or unsupported values are encountered.
465466
Unless support for a valid value is explicitly required, runtimes MAY choose which subset of the valid values it will support.
466467

467468
## Configuration Schema Example

0 commit comments

Comments
 (0)