jasder
/
runc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix several format issues found by pdf and html 

This carries #578 and fixes some other format issues.

Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
This commit is contained in:
Qiang Huang 2016-11-03 09:33:51 +08:00
parent b8e2ebec5f
commit 661314a926
3 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -6,21 +6,21 @@ The [Open Container Initiative](http://www.opencontainers.org/) develops specifi
Table of Contents Table of Contents
- [Introduction](README.md) - [Introduction](README.md)
- [Code of Conduct](#code-of-conduct) - [Code of Conduct](#code-of-conduct)
- [Container Principles](principles.md) - [Container Principles](principles.md)
- [Style and Conventions](style.md) - [Style and Conventions](style.md)
- [Roadmap](ROADMAP.md) - [Roadmap](ROADMAP.md)
- [Implementations](implementations.md) - [Implementations](implementations.md)
- [project](project.md) - [project](project.md)
- [Filesystem Bundle](bundle.md) - [Filesystem Bundle](bundle.md)
- Runtime and Lifecycle - Runtime and Lifecycle
- [General Runtime and Lifecycle](runtime.md) - [General Runtime and Lifecycle](runtime.md)
- [Linux-specific Runtime and Lifecycle](runtime-linux.md) - [Linux-specific Runtime and Lifecycle](runtime-linux.md)
- Configuration - Configuration
- [General Configuration](config.md) - [General Configuration](config.md)
- [Linux-specific Configuration](config-linux.md) - [Linux-specific Configuration](config-linux.md)
- [Solaris-specific Configuration](config-solaris.md) - [Solaris-specific Configuration](config-solaris.md)
- [Windows-specific Configuration](config-windows.md) - [Windows-specific Configuration](config-windows.md)
- [Glossary](glossary.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). 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).

7
config-linux.md
View File

@ -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. 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`. * **`major, minor`** *(int64, REQUIRED)* - major, minor numbers for device. More info in `man mknod`.
* **`rate`** *(uint64, REQUIRED)* - IO rate limit for the device * **`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 * **`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 * **`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.
processes in the group and egressing the system on various interfaces. The following parameters can be specified per-priority: The following parameters can be specified per-priority:
* **`name`** *(string, REQUIRED)* - interface name * **`name`** *(string, REQUIRED)* - interface name
* **`priority`** *(uint32, REQUIRED)* - priority applied to the interface * **`priority`** *(uint32, REQUIRED)* - priority applied to the interface

2
runtime.md
View File

@ -19,7 +19,7 @@ The value MAY be one of:
* `running`: the container has been created and the user-specified code is running * `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 * `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. * **`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. * **`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. This is provided so that consumers can find the container's configuration and root filesystem on the host.