Skip to content

Commit 661314a

Browse files
committed
Fix several format issues found by pdf and html
This carries #578 and fixes some other format issues. Signed-off-by: Qiang Huang <[email protected]>
1 parent b8e2ebe commit 661314a

File tree

3 files changed

+17
-16
lines changed

3 files changed

+17
-16
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@ The [Open Container Initiative](http://www.opencontainers.org/) develops specifi
66
Table of Contents
77

88
- [Introduction](README.md)
9-
- [Code of Conduct](#code-of-conduct)
10-
- [Container Principles](principles.md)
11-
- [Style and Conventions](style.md)
12-
- [Roadmap](ROADMAP.md)
13-
- [Implementations](implementations.md)
14-
- [project](project.md)
9+
- [Code of Conduct](#code-of-conduct)
10+
- [Container Principles](principles.md)
11+
- [Style and Conventions](style.md)
12+
- [Roadmap](ROADMAP.md)
13+
- [Implementations](implementations.md)
14+
- [project](project.md)
1515
- [Filesystem Bundle](bundle.md)
1616
- Runtime and Lifecycle
17-
- [General Runtime and Lifecycle](runtime.md)
18-
- [Linux-specific Runtime and Lifecycle](runtime-linux.md)
17+
- [General Runtime and Lifecycle](runtime.md)
18+
- [Linux-specific Runtime and Lifecycle](runtime-linux.md)
1919
- Configuration
20-
- [General Configuration](config.md)
21-
- [Linux-specific Configuration](config-linux.md)
22-
- [Solaris-specific Configuration](config-solaris.md)
23-
- [Windows-specific Configuration](config-windows.md)
20+
- [General Configuration](config.md)
21+
- [Linux-specific Configuration](config-linux.md)
22+
- [Solaris-specific Configuration](config-solaris.md)
23+
- [Windows-specific Configuration](config-windows.md)
2424
- [Glossary](glossary.md)
2525

2626
In the specifications in the above table of contents, the keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119) (Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997).

config-linux.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -361,7 +361,8 @@ The following parameters can be specified to setup the controller:
361361

362362
You must specify at least one of `weight` or `leafWeight` in a given entry, and can specify both.
363363

364-
* **`blkioThrottleReadBpsDevice`**, **`blkioThrottleWriteBpsDevice`**, **`blkioThrottleReadIOPSDevice`**, **`blkioThrottleWriteIOPSDevice`** *(array, OPTIONAL)* - specify the list of devices which will be IO rate limited. The following parameters can be specified per-device:
364+
* **`blkioThrottleReadBpsDevice`**, **`blkioThrottleWriteBpsDevice`**, **`blkioThrottleReadIOPSDevice`**, **`blkioThrottleWriteIOPSDevice`** *(array, OPTIONAL)* - specify the list of devices which will be IO rate limited.
365+
The following parameters can be specified per-device:
365366
* **`major, minor`** *(int64, REQUIRED)* - major, minor numbers for device. More info in `man mknod`.
366367
* **`rate`** *(uint64, REQUIRED)* - IO rate limit for the device
367368

@@ -433,8 +434,8 @@ The following parameters can be specified to setup the controller:
433434

434435
* **`classID`** *(uint32, OPTIONAL)* - is the network class identifier the cgroup's network packets will be tagged with
435436

436-
* **`priorities`** *(array, OPTIONAL)* - specifies a list of objects of the priorities assigned to traffic originating from
437-
processes in the group and egressing the system on various interfaces. The following parameters can be specified per-priority:
437+
* **`priorities`** *(array, OPTIONAL)* - specifies a list of objects of the priorities assigned to traffic originating from processes in the group and egressing the system on various interfaces.
438+
The following parameters can be specified per-priority:
438439
* **`name`** *(string, REQUIRED)* - interface name
439440
* **`priority`** *(uint32, REQUIRED)* - priority applied to the interface
440441

runtime.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The value MAY be one of:
1919
* `running`: the container has been created and the user-specified code is running
2020
* `stopped`: the container has been created and the user-specified code has been executed but is no longer running
2121

22-
Additional values MAY be defined by the runtime, however, they MUST be used to represent new runtime states not defined above.
22+
Additional values MAY be defined by the runtime, however, they MUST be used to represent new runtime states not defined above.
2323
* **`pid`**: (int) is the ID of the container process, as seen by the host.
2424
* **`bundlePath`**: (string) is the absolute path to the container's bundle directory.
2525
This is provided so that consumers can find the container's configuration and root filesystem on the host.

0 commit comments

Comments
 (0)