From 661314a9267f315f44cda99ac255f445868a4224 Mon Sep 17 00:00:00 2001 From: Qiang Huang Date: Thu, 3 Nov 2016 09:33:51 +0800 Subject: [PATCH] Fix several format issues found by pdf and html This carries #578 and fixes some other format issues. Signed-off-by: Qiang Huang --- README.md | 24 ++++++++++++------------ config-linux.md | 7 ++++--- runtime.md | 2 +- 3 files changed, 17 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index ad9fa705..3d24ce16 100644 --- a/README.md +++ b/README.md @@ -6,21 +6,21 @@ The [Open Container Initiative](http://www.opencontainers.org/) develops specifi Table of Contents - [Introduction](README.md) - - [Code of Conduct](#code-of-conduct) - - [Container Principles](principles.md) - - [Style and Conventions](style.md) - - [Roadmap](ROADMAP.md) - - [Implementations](implementations.md) - - [project](project.md) + - [Code of Conduct](#code-of-conduct) + - [Container Principles](principles.md) + - [Style and Conventions](style.md) + - [Roadmap](ROADMAP.md) + - [Implementations](implementations.md) + - [project](project.md) - [Filesystem Bundle](bundle.md) - Runtime and Lifecycle - - [General Runtime and Lifecycle](runtime.md) - - [Linux-specific Runtime and Lifecycle](runtime-linux.md) + - [General Runtime and Lifecycle](runtime.md) + - [Linux-specific Runtime and Lifecycle](runtime-linux.md) - Configuration - - [General Configuration](config.md) - - [Linux-specific Configuration](config-linux.md) - - [Solaris-specific Configuration](config-solaris.md) - - [Windows-specific Configuration](config-windows.md) + - [General Configuration](config.md) + - [Linux-specific Configuration](config-linux.md) + - [Solaris-specific Configuration](config-solaris.md) + - [Windows-specific Configuration](config-windows.md) - [Glossary](glossary.md) 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). diff --git a/config-linux.md b/config-linux.md index de8cd624..cbd3cc5a 100644 --- a/config-linux.md +++ b/config-linux.md @@ -361,7 +361,8 @@ The following parameters can be specified to setup the controller: You must specify at least one of `weight` or `leafWeight` in a given entry, and can specify both. -* **`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: +* **`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: * **`major, minor`** *(int64, REQUIRED)* - major, minor numbers for device. More info in `man mknod`. * **`rate`** *(uint64, REQUIRED)* - IO rate limit for the device @@ -433,8 +434,8 @@ The following parameters can be specified to setup the controller: * **`classID`** *(uint32, OPTIONAL)* - is the network class identifier the cgroup's network packets will be tagged with -* **`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. The following parameters can be specified per-priority: +* **`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. + The following parameters can be specified per-priority: * **`name`** *(string, REQUIRED)* - interface name * **`priority`** *(uint32, REQUIRED)* - priority applied to the interface diff --git a/runtime.md b/runtime.md index 5b4b1412..cedb224c 100644 --- a/runtime.md +++ b/runtime.md @@ -19,7 +19,7 @@ The value MAY be one of: * `running`: the container has been created and the user-specified code is running * `stopped`: the container has been created and the user-specified code has been executed but is no longer running - Additional values MAY be defined by the runtime, however, they MUST be used to represent new runtime states not defined above. + Additional values MAY be defined by the runtime, however, they MUST be used to represent new runtime states not defined above. * **`pid`**: (int) is the ID of the container process, as seen by the host. * **`bundlePath`**: (string) is the absolute path to the container's bundle directory. This is provided so that consumers can find the container's configuration and root filesystem on the host.