Skip to content

Commit 279010f

Browse files
committed
*.md: normalize the "example" anchors
Signed-off-by: Vincent Batts <[email protected]>
1 parent b37fe27 commit 279010f

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

config.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The OpenContainer spec follows semantic versioning and retains forward and backw
1515
For example, if an implementation is compliant with version 1.0.1 of the spec, it is compatible with the complete 1.x series.
1616
NOTE that there is no guarantee for forward or backward compatibility for version 0.x.
1717

18-
*Example*
18+
### Example
1919

2020
```json
2121
"ociVersion": "0.1.0"
@@ -28,7 +28,7 @@ Each container has exactly one *root filesystem*, specified in the *root* object
2828
* **`path`** (string, required) Specifies the path to the root filesystem for the container, relative to the path where the manifest is. A directory MUST exist at the relative path declared by the field.
2929
* **`readonly`** (bool, optional) If true then the root filesystem MUST be read-only inside the container. Defaults to false.
3030

31-
*Example*
31+
### Example
3232

3333
```json
3434
"root": {
@@ -48,7 +48,7 @@ The parameters are similar to the ones in [the Linux mount system call](http://m
4848
* **`source`** (string, required) a device name, but can also be a directory name or a dummy. Windows, the volume name that is the target of the mount point. \\?\Volume\{GUID}\ (on Windows source is called target)
4949
* **`options`** (list of strings, optional) in the fstab format [https://wiki.archlinux.org/index.php/Fstab](https://wiki.archlinux.org/index.php/Fstab).
5050

51-
### Linux Example
51+
### Example (Linux)
5252

5353
```json
5454
"mounts": [
@@ -67,7 +67,7 @@ The parameters are similar to the ones in [the Linux mount system call](http://m
6767
]
6868
```
6969

70-
### Windows Example
70+
### Example (Windows)
7171

7272
```json
7373
"mounts": [
@@ -111,7 +111,7 @@ For Linux-based systems the user structure has the following fields:
111111
* **`gid`** (int, required) specifies the group id.
112112
* **`additionalGids`** (array of ints, optional) specifies additional group ids to be added to the process.
113113

114-
*Example (Linux)*
114+
### Example (Linux)
115115

116116
```json
117117
"process": {
@@ -152,7 +152,7 @@ For Linux-based systems the user structure has the following fields:
152152

153153
* **`hostname`** (string, optional) as it is accessible to processes running inside. On Linux, you can only set this if your bundle creates a new [UTS namespace][uts-namespace].
154154

155-
*Example*
155+
### Example
156156

157157
```json
158158
"hostname": "mrsdalloway"
@@ -163,6 +163,8 @@ For Linux-based systems the user structure has the following fields:
163163
* **`os`** (string, required) specifies the operating system family this image must run on. Values for os must be in the list specified by the Go Language document for [`$GOOS`](https://golang.org/doc/install/source#environment).
164164
* **`arch`** (string, required) specifies the instruction set for which the binaries in the image have been compiled. Values for arch must be in the list specified by the Go Language document for [`$GOARCH`](https://golang.org/doc/install/source#environment).
165165

166+
### Example
167+
166168
```json
167169
"platform": {
168170
"os": "linux",
@@ -209,7 +211,7 @@ The post-stop hooks are called after the container process is stopped.
209211
Cleanup or debugging could be performed in such a hook.
210212
If a hook returns a non-zero exit code, then an error is logged and the remaining hooks are executed.
211213

212-
*Example*
214+
### Example
213215

214216
```json
215217
"hooks" : {

runtime.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ This allows the hooks to perform cleanup and teardown logic after the runtime de
2020
This is provided so that consumers can find the container's configuration and root filesystem on the host.
2121

2222
When serialized in JSON, the format MUST adhere to the following pattern:
23+
2324
```json
2425
{
2526
"ociVersion": "0.2.0",
@@ -99,8 +100,10 @@ The JSON describing the new process MUST adhere to the [Process configuration](c
99100
This operation MUST create a new process within the scope of the container.
100101
If the container is not running then this operation MUST have no effect on the container and MUST generate an error.
101102
Executing this operation multiple times MUST result in a new process each time.
102-
Example:
103-
```
103+
104+
#### Example
105+
106+
```json
104107
{
105108
"terminal": true,
106109
"user": {
@@ -118,6 +121,7 @@ Example:
118121
"cwd": "...",
119122
}
120123
```
124+
121125
This specification does not mandate the name of this JSON file.
122126
See the specification of the `config.json` file for the definition of these fields.
123127
The stopping, or exiting, of these secondary process MUST have no effect on the state of the container.

0 commit comments

Comments
 (0)