You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
config*: Dedent paragraphs that aren't a list entry
Like 5d9bbad (config: Dedent root paragraphs, since they aren't a
list entry, 2017-11-08, opencontainers#936). Ma Shimiao pointed out that there may
be more instances of this [1], and this commit fixes all instances
turned up with:
$ git grep -B1 '^ [^ ]' | grep -A1 '[:-]\*\*'
[1]: opencontainers#934 (comment)
Signed-off-by: W. Trevor King <[email protected]>
Copy file name to clipboardExpand all lines: config-linux.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -458,10 +458,10 @@ The following parameters can be specified to set up the controller:
458
458
## <aname="configLinuxIntelRdt" />IntelRdt
459
459
460
460
**`intelRdt`** (object, OPTIONAL) represents the [Intel Resource Director Technology][intel-rdt-cat-kernel-interface].
461
-
If `intelRdt` is set, the runtime MUST write the container process ID to the `<container-id>/tasks` file in a mounted `resctrl` pseudo-filesystem, using the container ID from [`start`](runtime.md#start) and creating the `<container-id>` directory if necessary.
462
-
If no mounted `resctrl` pseudo-filesystem is available in the [runtime mount namespace](glossary.md#runtime-namespace), the runtime MUST [generate an error](runtime.md#errors).
461
+
If `intelRdt` is set, the runtime MUST write the container process ID to the `<container-id>/tasks` file in a mounted `resctrl` pseudo-filesystem, using the container ID from [`start`](runtime.md#start) and creating the `<container-id>` directory if necessary.
462
+
If no mounted `resctrl` pseudo-filesystem is available in the [runtime mount namespace](glossary.md#runtime-namespace), the runtime MUST [generate an error](runtime.md#errors).
463
463
464
-
If `intelRdt` is not set, the runtime MUST NOT manipulate any `resctrl` pseudo-filesystems.
464
+
If `intelRdt` is not set, the runtime MUST NOT manipulate any `resctrl` pseudo-filesystems.
465
465
466
466
The following parameters can be specified for the container:
467
467
@@ -592,8 +592,8 @@ The following parameters can be specified to set up seccomp:
592
592
## <aname="configLinuxRootfsMountPropagation" />Rootfs Mount Propagation
593
593
594
594
**`rootfsPropagation`** (string, OPTIONAL) sets the rootfs's mount propagation.
595
-
Its value is either slave, private, shared or unbindable.
596
-
The [Shared Subtrees][sharedsubtree] article in the kernel documentation has more information about mount propagation.
595
+
Its value is either slave, private, shared or unbindable.
596
+
The [Shared Subtrees][sharedsubtree] article in the kernel documentation has more information about mount propagation.
597
597
598
598
### Example
599
599
@@ -604,7 +604,7 @@ The following parameters can be specified to set up seccomp:
604
604
## <aname="configLinuxMaskedPaths" />Masked Paths
605
605
606
606
**`maskedPaths`** (array of strings, OPTIONAL) will mask over the provided paths inside the container so that they cannot be read.
607
-
The values MUST be absolute paths in the [container namespace](glossary.md#container_namespace).
607
+
The values MUST be absolute paths in the [container namespace](glossary.md#container_namespace).
608
608
609
609
### Example
610
610
@@ -617,7 +617,7 @@ The following parameters can be specified to set up seccomp:
Copy file name to clipboardExpand all lines: config.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,9 +65,9 @@ On all other platforms, this field is REQUIRED.
65
65
## <aname="configMounts" />Mounts
66
66
67
67
**`mounts`** (array of objects, OPTIONAL) specifies additional mounts beyond [`root`](#root).
68
-
The runtime MUST mount entries in the listed order.
69
-
For Linux, the parameters are as documented in [mount(2)][mount.2] system call man page.
70
-
For Solaris, the mount entry corresponds to the 'fs' resource in the [zonecfg(1M)][zonecfg.1m] man page.
68
+
The runtime MUST mount entries in the listed order.
69
+
For Linux, the parameters are as documented in [mount(2)][mount.2] system call man page.
70
+
For Solaris, the mount entry corresponds to the 'fs' resource in the [zonecfg(1M)][zonecfg.1m] man page.
71
71
72
72
***`destination`** (string, REQUIRED) Destination of mount point: path inside container.
73
73
This value MUST be an absolute path.
@@ -143,7 +143,7 @@ For POSIX platforms the `mounts` structure has the following fields:
143
143
## <aname="configProcess" />Process
144
144
145
145
**`process`** (object, OPTIONAL) specifies the container process.
146
-
This property is REQUIRED when [`start`](runtime.md#start) is called.
146
+
This property is REQUIRED when [`start`](runtime.md#start) is called.
147
147
148
148
***`terminal`** (bool, OPTIONAL) specifies whether a terminal is attached to the process, defaults to false.
149
149
As an example, if set to true on Linux a pseudoterminal pair is allocated for the process and the pseudoterminal slave is duplicated on the process's [standard streams][stdin.3].
@@ -433,18 +433,18 @@ Cleanup or debugging functions are examples of such a hook.
433
433
## <aname="configAnnotations" />Annotations
434
434
435
435
**`annotations`** (object, OPTIONAL) contains arbitrary metadata for the container.
436
-
This information MAY be structured or unstructured.
437
-
Annotations MUST be a key-value map.
438
-
If there are no annotations then this property MAY either be absent or an empty map.
439
-
440
-
Keys MUST be strings.
441
-
Keys MUST NOT be an empty string.
442
-
Keys SHOULD be named using a reverse domain notation - e.g. `com.example.myKey`.
443
-
Keys using the `org.opencontainers` namespace are reserved and MUST NOT be used by subsequent specifications.
444
-
Implementations that are reading/processing this configuration file MUST NOT generate an error if they encounter an unknown annotation key.
445
-
446
-
Values MUST be strings.
447
-
Values MAY be an empty string.
436
+
This information MAY be structured or unstructured.
437
+
Annotations MUST be a key-value map.
438
+
If there are no annotations then this property MAY either be absent or an empty map.
439
+
440
+
Keys MUST be strings.
441
+
Keys MUST NOT be an empty string.
442
+
Keys SHOULD be named using a reverse domain notation - e.g. `com.example.myKey`.
443
+
Keys using the `org.opencontainers` namespace are reserved and MUST NOT be used by subsequent specifications.
444
+
Implementations that are reading/processing this configuration file MUST NOT generate an error if they encounter an unknown annotation key.
0 commit comments