Skip to content

Commit 767eeaf

Browse files
committed
config: Use "POSIX" instead of "Linux and Solaris"
As requested by Michael [1], this reduces the number of changes required if BSD or some such is added to the config. This change leaves a bit of a gap between the platforms listed in spec.md, since readers have to figure out on their own that the POSIX properties apply to the linux and solaris platforms (and potentially other future platforms). But Michael felt like it's ok to leave that gap, at least for now [2]. I've used "On POSIX platforms" and similar (instead of "On POSIX") because, as Tianon points out [3], there is some space between POSIX-the-spec and platforms which implement it. [1]: #838 (comment) [2]: http://ircbot.wl.linuxfoundation.org/meetings/opencontainers/2017/opencontainers.2017-06-01-17.41.log.html#l-60 [3]: #838 (comment) Signed-off-by: W. Trevor King <[email protected]>
1 parent 2022e3e commit 767eeaf

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

config.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ For all platform-specific configuration values, the scope defined below in the [
3636

3737
* On Windows, `path` MUST be a [volume GUID path][naming-a-volume].
3838

39-
* On Linux and Solaris, `path` is either an absolute path or a relative path to the bundle.
39+
* On POSIX platforms, `path` is either an absolute path or a relative path to the bundle.
4040
For example, with a bundle at `/to/bundle` and a root filesystem at `/to/bundle/rootfs`, the `path` value can be either `/to/bundle/rootfs` or `rootfs`.
4141
The value SHOULD be the conventional `rootfs`.
4242

@@ -45,7 +45,7 @@ For all platform-specific configuration values, the scope defined below in the [
4545
* **`readonly`** (bool, OPTIONAL) If true then the root filesystem MUST be read-only inside the container, defaults to false.
4646
* On Windows, this field MUST be omitted or false.
4747

48-
### Example (POSIX)
48+
### Example (POSIX platforms)
4949

5050
```json
5151
"root": {
@@ -94,9 +94,9 @@ For all platform-specific configuration values, the scope defined below in the [
9494
]
9595
```
9696

97-
### <a name="configLinuxAndSolarisMounts" />Linux and Solaris Mounts
97+
### <a name="configPOSIXMounts" />POSIX-platform Mounts
9898

99-
For Linux and Solaris based systems the mounts structure has the following fields:
99+
For POSIX platforms the `mounts` structure has the following fields:
100100

101101
* **`type`** (string, OPTIONAL) The type of the filesystem to be mounted.
102102
* Linux: filesystem types supported by the kernel as listed in */proc/filesystems* (e.g., "minix", "ext2", "ext3", "jfs", "xfs", "reiserfs", "msdos", "proc", "nfs", "iso9660").
@@ -195,9 +195,9 @@ For Linux-based systems the process structure supports the following process-spe
195195

196196
The user for the process is a platform-specific structure that allows specific control over which user the process runs as.
197197

198-
#### <a name="configLinuxAndSolarisUser" />Linux and Solaris User
198+
#### <a name="configPOSIXUser" />POSIX-platform User
199199

200-
For Linux and Solaris based systems the user structure has the following fields:
200+
For POSIX platforms the `user` structure has the following fields:
201201

202202
* **`uid`** (int, REQUIRED) specifies the user ID in the [container namespace](glossary.md#container-namespace).
203203
* **`gid`** (int, REQUIRED) specifies the group ID in the [container namespace](glossary.md#container-namespace).
@@ -348,9 +348,9 @@ For Windows based systems the user structure has the following fields:
348348
}
349349
```
350350

351-
## <a name="configHooks" />Linux and Solaris Hooks
351+
## <a name="configHooks" />POSIX-platform Hooks
352352

353-
For Linux- and Solaris-based systems, the configuration structure supports `hooks` for configuring custom actions related to the [lifecycle](runtime.md#lifecycle) of the container.
353+
For POSIX platforms, the configuration structure supports `hooks` for configuring custom actions related to the [lifecycle](runtime.md#lifecycle) of the container.
354354

355355
* **`hooks`** (object, OPTIONAL) MAY contain any of the following properties:
356356
* **`prestart`** (array of objects, OPTIONAL) is an array of [pre-start hooks](#prestart).

0 commit comments

Comments
 (0)