kotovalexarian-likes-github/moby--moby
1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
Code Releases Activity

image spec formatting fix

Browse source 
Embedded new lines aren't interpreted correctly in markdown renderers (they are treated as preformatted text instead). I removed the embedded newlines in the docker image spec.

Signed-off-by: Alex Goodman <wagoodman@gmail.com>
This commit is contained in:
Alex Goodman 2018-05-13 12:53:05 -04:00 committed by Alex Goodman
parent 996eb78fb8
commit 4fb59c20a4
No known key found for this signature in database
GPG key ID: 05328C611D8A520E
3 changed files with 21 additions and 65 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
image/spec/v1.1.md
View file

@ -223,9 +223,7 @@ whitespace. It has been added to this example for clarity.
container using the image. This field can be <code>null</code>, in container using the image. This field can be <code>null</code>, in
which case any execution parameters should be specified at creation of which case any execution parameters should be specified at creation of
the container. the container.
<h4>Container RunConfig Field Descriptions</h4> <h4>Container RunConfig Field Descriptions</h4>
<dl> <dl>
<dt> <dt>
User <code>string</code> User <code>string</code>
@ -234,9 +232,7 @@ whitespace. It has been added to this example for clarity.
<p>The username or UID which the process in the container should <p>The username or UID which the process in the container should
run as. This acts as a default value to use when the value is run as. This acts as a default value to use when the value is
not specified when creating a container.</p> not specified when creating a container.</p>
<p>All of the following are valid:</p> <p>All of the following are valid:</p>
<ul> <ul>
<li><code>user</code></li> <li><code>user</code></li>
<li><code>uid</code></li> <li><code>uid</code></li>
@ -245,7 +241,6 @@ whitespace. It has been added to this example for clarity.
<li><code>uid:group</code></li> <li><code>uid:group</code></li>
<li><code>user:gid</code></li> <li><code>user:gid</code></li>
</ul> </ul>
<p>If <code>group</code>/<code>gid</code> is not specified, the <p>If <code>group</code>/<code>gid</code> is not specified, the
default group and supplementary groups of the given default group and supplementary groups of the given
<code>user</code>/<code>uid</code> in <code>/etc/passwd</code> <code>user</code>/<code>uid</code> in <code>/etc/passwd</code>
@ -284,13 +279,11 @@ whitespace. It has been added to this example for clarity.
<code>map[string]struct{}</code> and is represented in JSON as <code>map[string]struct{}</code> and is represented in JSON as
an object mapping its keys to an empty object. Here is an an object mapping its keys to an empty object. Here is an
example: example:
<pre>{ <pre>{
"8080": {}, "8080": {},
"53/udp": {}, "53/udp": {},
"2356/tcp": {} "2356/tcp": {}
}</pre> }</pre>
Its keys can be in the format of: Its keys can be in the format of:
<ul> <ul>
<li> <li>
@ -304,10 +297,8 @@ whitespace. It has been added to this example for clarity.
</li> </li>
</ul> </ul>
with the default protocol being <code>"tcp"</code> if not with the default protocol being <code>"tcp"</code> if not
specified. specified. These values act as defaults and are merged with any
specified when creating a container.
These values act as defaults and are merged with any specified
when creating a container.
</dd> </dd>
<dt> <dt>
Env <code>array of strings</code> Env <code>array of strings</code>
@ -367,7 +358,6 @@ whitespace. It has been added to this example for clarity.
The rootfs key references the layer content addresses used by the The rootfs key references the layer content addresses used by the
image. This makes the image config hash depend on the filesystem hash. image. This makes the image config hash depend on the filesystem hash.
rootfs has two subkeys: rootfs has two subkeys:
<ul> <ul>
<li> <li>
<code>type</code> is usually set to <code>layers</code>. <code>type</code> is usually set to <code>layers</code>.
@ -376,10 +366,7 @@ whitespace. It has been added to this example for clarity.
<code>diff_ids</code> is an array of layer content hashes (<code>DiffIDs</code>), in order from bottom-most to top-most. <code>diff_ids</code> is an array of layer content hashes (<code>DiffIDs</code>), in order from bottom-most to top-most.
</li> </li>
</ul> </ul>
Here is an example rootfs section: Here is an example rootfs section:
<pre>"rootfs": { <pre>"rootfs": {
"diff_ids": [ "diff_ids": [
"sha256:c6f988f4874bb0add23a778f753c65efe992244e148a1d2ec2a8b664fb66bbd1", "sha256:c6f988f4874bb0add23a778f753c65efe992244e148a1d2ec2a8b664fb66bbd1",
@ -396,7 +383,6 @@ whitespace. It has been added to this example for clarity.
<code>history</code> is an array of objects describing the history of <code>history</code> is an array of objects describing the history of
each layer. The array is ordered from bottom-most layer to top-most each layer. The array is ordered from bottom-most layer to top-most
layer. The object has the following fields. layer. The object has the following fields.
<ul> <ul>
<li> <li>
<code>created</code>: Creation time, expressed as a ISO-8601 formatted <code>created</code>: Creation time, expressed as a ISO-8601 formatted

31
image/spec/v1.2.md
View file

@ -223,9 +223,7 @@ whitespace. It has been added to this example for clarity.
container using the image. This field can be <code>null</code>, in container using the image. This field can be <code>null</code>, in
which case any execution parameters should be specified at creation of which case any execution parameters should be specified at creation of
the container. the container.
<h4>Container RunConfig Field Descriptions</h4> <h4>Container RunConfig Field Descriptions</h4>
<dl> <dl>
<dt> <dt>
User <code>string</code> User <code>string</code>
@ -234,9 +232,7 @@ whitespace. It has been added to this example for clarity.
<p>The username or UID which the process in the container should <p>The username or UID which the process in the container should
run as. This acts as a default value to use when the value is run as. This acts as a default value to use when the value is
not specified when creating a container.</p> not specified when creating a container.</p>
<p>All of the following are valid:</p> <p>All of the following are valid:</p>
<ul> <ul>
<li><code>user</code></li> <li><code>user</code></li>
<li><code>uid</code></li> <li><code>uid</code></li>
@ -245,7 +241,6 @@ whitespace. It has been added to this example for clarity.
<li><code>uid:group</code></li> <li><code>uid:group</code></li>
<li><code>user:gid</code></li> <li><code>user:gid</code></li>
</ul> </ul>
<p>If <code>group</code>/<code>gid</code> is not specified, the <p>If <code>group</code>/<code>gid</code> is not specified, the
default group and supplementary groups of the given default group and supplementary groups of the given
<code>user</code>/<code>uid</code> in <code>/etc/passwd</code> <code>user</code>/<code>uid</code> in <code>/etc/passwd</code>
@ -284,13 +279,11 @@ whitespace. It has been added to this example for clarity.
<code>map[string]struct{}</code> and is represented in JSON as <code>map[string]struct{}</code> and is represented in JSON as
an object mapping its keys to an empty object. Here is an an object mapping its keys to an empty object. Here is an
example: example:
<pre>{ <pre>{
"8080": {}, "8080": {},
"53/udp": {}, "53/udp": {},
"2356/tcp": {} "2356/tcp": {}
}</pre> }</pre>
Its keys can be in the format of: Its keys can be in the format of:
<ul> <ul>
<li> <li>
@ -304,10 +297,8 @@ whitespace. It has been added to this example for clarity.
</li> </li>
</ul> </ul>
with the default protocol being <code>"tcp"</code> if not with the default protocol being <code>"tcp"</code> if not
specified. specified. These values act as defaults and are merged with
any specified when creating a container.
These values act as defaults and are merged with any specified
when creating a container.
</dd> </dd>
<dt> <dt>
Env <code>array of strings</code> Env <code>array of strings</code>
@ -364,7 +355,6 @@ whitespace. It has been added to this example for clarity.
<li><code>["CMD", arg1, arg2, ...]</code> : exec arguments directly</li> <li><code>["CMD", arg1, arg2, ...]</code> : exec arguments directly</li>
<li><code>["CMD-SHELL", command]</code> : run command with system's default shell</li> <li><code>["CMD-SHELL", command]</code> : run command with system's default shell</li>
</ul> </ul>
The test command should exit with a status of 0 if the container is healthy, The test command should exit with a status of 0 if the container is healthy,
or with 1 if it is unhealthy. or with 1 if it is unhealthy.
</dd> </dd>
@ -387,12 +377,10 @@ whitespace. It has been added to this example for clarity.
The number of consecutive failures needed to consider a container as unhealthy. The number of consecutive failures needed to consider a container as unhealthy.
</dd> </dd>
</dl> </dl>
In each case, the field can be omitted to indicate that the In each case, the field can be omitted to indicate that the
value should be inherited from the base layer. value should be inherited from the base layer. These values act
as defaults and are merged with any specified when creating a
These values act as defaults and are merged with any specified container.
when creating a container.
</dd> </dd>
<dt> <dt>
Volumes <code>struct</code> Volumes <code>struct</code>
@ -426,7 +414,6 @@ whitespace. It has been added to this example for clarity.
The rootfs key references the layer content addresses used by the The rootfs key references the layer content addresses used by the
image. This makes the image config hash depend on the filesystem hash. image. This makes the image config hash depend on the filesystem hash.
rootfs has two subkeys: rootfs has two subkeys:
<ul> <ul>
<li> <li>
<code>type</code> is usually set to <code>layers</code>. <code>type</code> is usually set to <code>layers</code>.
@ -435,10 +422,7 @@ whitespace. It has been added to this example for clarity.
<code>diff_ids</code> is an array of layer content hashes (<code>DiffIDs</code>), in order from bottom-most to top-most. <code>diff_ids</code> is an array of layer content hashes (<code>DiffIDs</code>), in order from bottom-most to top-most.
</li> </li>
</ul> </ul>
Here is an example rootfs section: Here is an example rootfs section:
<pre>"rootfs": { <pre>"rootfs": {
"diff_ids": [ "diff_ids": [
"sha256:c6f988f4874bb0add23a778f753c65efe992244e148a1d2ec2a8b664fb66bbd1", "sha256:c6f988f4874bb0add23a778f753c65efe992244e148a1d2ec2a8b664fb66bbd1",
@ -455,7 +439,6 @@ whitespace. It has been added to this example for clarity.
<code>history</code> is an array of objects describing the history of <code>history</code> is an array of objects describing the history of
each layer. The array is ordered from bottom-most layer to top-most each layer. The array is ordered from bottom-most layer to top-most
layer. The object has the following fields. layer. The object has the following fields.
<ul> <ul>
<li> <li>
<code>created</code>: Creation time, expressed as a ISO-8601 formatted <code>created</code>: Creation time, expressed as a ISO-8601 formatted
@ -478,9 +461,7 @@ whitespace. It has been added to this example for clarity.
filesystem). filesystem).
</li> </li>
</ul> </ul>
Here is an example history section:
Here is an example history section:
<pre>"history": [ <pre>"history": [
{ {
"created": "2015-10-31T22:22:54.690851953Z", "created": "2015-10-31T22:22:54.690851953Z",

37
image/spec/v1.md
View file

@ -17,12 +17,10 @@ This specification uses the following terms:
<dd> <dd>
Images are composed of <i>layers</i>. <i>Image layer</i> is a general Images are composed of <i>layers</i>. <i>Image layer</i> is a general
term which may be used to refer to one or both of the following: term which may be used to refer to one or both of the following:
<ol> <ol>
<li>The metadata for the layer, described in the JSON format.</li> <li>The metadata for the layer, described in the JSON format.</li>
<li>The filesystem changes described by a layer.</li> <li>The filesystem changes described by a layer.</li>
</ol> </ol>
To refer to the former you may use the term <i>Layer JSON</i> or To refer to the former you may use the term <i>Layer JSON</i> or
<i>Layer Metadata</i>. To refer to the latter you may use the term <i>Layer Metadata</i>. To refer to the latter you may use the term
<i>Image Filesystem Changeset</i> or <i>Image Diff</i>. <i>Image Filesystem Changeset</i> or <i>Image Diff</i>.
@ -244,9 +242,7 @@ Here is an example image JSON file:
container using the image. This field can be <code>null</code>, in container using the image. This field can be <code>null</code>, in
which case any execution parameters should be specified at creation of which case any execution parameters should be specified at creation of
the container. the container.
<h4>Container RunConfig Field Descriptions</h4> <h4>Container RunConfig Field Descriptions</h4>
<dl> <dl>
<dt> <dt>
User <code>string</code> User <code>string</code>
@ -255,9 +251,7 @@ Here is an example image JSON file:
<p>The username or UID which the process in the container should <p>The username or UID which the process in the container should
run as. This acts as a default value to use when the value is run as. This acts as a default value to use when the value is
not specified when creating a container.</p> not specified when creating a container.</p>
<p>All of the following are valid:</p> <p>All of the following are valid:</p>
<ul> <ul>
<li><code>user</code></li> <li><code>user</code></li>
<li><code>uid</code></li> <li><code>uid</code></li>
@ -266,7 +260,6 @@ Here is an example image JSON file:
<li><code>uid:group</code></li> <li><code>uid:group</code></li>
<li><code>user:gid</code></li> <li><code>user:gid</code></li>
</ul> </ul>
<p>If <code>group</code>/<code>gid</code> is not specified, the <p>If <code>group</code>/<code>gid</code> is not specified, the
default group and supplementary groups of the given default group and supplementary groups of the given
<code>user</code>/<code>uid</code> in <code>/etc/passwd</code> <code>user</code>/<code>uid</code> in <code>/etc/passwd</code>
@ -305,13 +298,11 @@ Here is an example image JSON file:
<code>map[string]struct{}</code> and is represented in JSON as <code>map[string]struct{}</code> and is represented in JSON as
an object mapping its keys to an empty object. Here is an an object mapping its keys to an empty object. Here is an
example: example:
<pre>{ <pre>{
"8080": {}, "8080": {},
"53/udp": {}, "53/udp": {},
"2356/tcp": {} "2356/tcp": {}
}</pre> }</pre>
Its keys can be in the format of: Its keys can be in the format of:
<ul> <ul>
<li> <li>
@ -325,9 +316,7 @@ Here is an example image JSON file:
</li> </li>
</ul> </ul>
with the default protocol being <code>"tcp"</code> if not with the default protocol being <code>"tcp"</code> if not
specified. specified. These values act as defaults and are merged with any specified
These values act as defaults and are merged with any specified
when creating a container. when creating a container.
</dd> </dd>
<dt> <dt>
@ -502,21 +491,21 @@ For example, here's what the full archive of `library/busybox` is (displayed in
``` ```
. .
├── 5785b62b697b99a5af6cd5d0aabc804d5748abbb6d3d07da5d1d3795f2dcc83e ├── 5785b62b697b99a5af6cd5d0aabc804d5748abbb6d3d07da5d1d3795f2dcc83e
│   ├── VERSION │ ├── VERSION
│   ├── json │ ├── json
│   └── layer.tar │ └── layer.tar
├── a7b8b41220991bfc754d7ad445ad27b7f272ab8b4a2c175b9512b97471d02a8a ├── a7b8b41220991bfc754d7ad445ad27b7f272ab8b4a2c175b9512b97471d02a8a
│   ├── VERSION │ ├── VERSION
│   ├── json │ ├── json
│   └── layer.tar │ └── layer.tar
├── a936027c5ca8bf8f517923169a233e391cbb38469a75de8383b5228dc2d26ceb ├── a936027c5ca8bf8f517923169a233e391cbb38469a75de8383b5228dc2d26ceb
│   ├── VERSION │ ├── VERSION
│   ├── json │ ├── json
│   └── layer.tar │ └── layer.tar
├── f60c56784b832dd990022afc120b8136ab3da9528094752ae13fe63a2d28dc8c ├── f60c56784b832dd990022afc120b8136ab3da9528094752ae13fe63a2d28dc8c
│   ├── VERSION │ ├── VERSION
│   ├── json │ ├── json
│   └── layer.tar │ └── layer.tar
└── repositories └── repositories
``` ```