You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: implementations.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,18 @@
1
-
# Implementations
1
+
# <aname="implementations" />Implementations
2
2
3
3
The following sections link to associated projects, some of which are maintained by the OCI and some of which are maintained by external organizations.
4
4
If you know of any associated projects that are not listed here, please file a pull request adding a link to that project.
The [Open Container Initiative](http://www.opencontainers.org/) develops specifications for standards on Operating System process and application containers.
4
4
5
-
# Abstract
5
+
# <aname="ociRuntimeSpecAbstract" />Abstract
6
6
7
7
The OCI Runtime Specification aims to specify the configuration, execution environment, and lifecycle a container.
8
8
9
9
A container's configuration is specified as the `config.json` for the supported platforms and details the fields that enable the creation of a container.
10
10
The execution environment is specified to ensure that applications running inside a container have a consistent environment between runtimes along with common actions defined for the container's lifecycle.
11
11
12
-
# Platforms
12
+
# <aname="ociRuntimeSpecPlatforms" />Platforms
13
13
14
14
Platforms defined by this specification are:
15
15
16
16
*`linux`: [runtime.md](runtime.md), [config.md](config.md), [config-linux.md](config-linux.md), and [runtime-linux.md](runtime-linux.md).
17
17
*`solaris`: [runtime.md](runtime.md), [config.md](config.md), and [config-solaris.md](config-solaris.md).
18
18
*`windows`: [runtime.md](runtime.md), [config.md](config.md), and [config-windows.md](config-windows.md).
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in [RFC 2119][rfc2119].
Copy file name to clipboardExpand all lines: style.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,29 +1,29 @@
1
-
# Style and conventions
1
+
# <aname="styleAndConventions" />Style and conventions
2
2
3
-
## One sentence per line
3
+
## <aname="styleOneSentence" />One sentence per line
4
4
5
5
To keep consistency throughout the Markdown files in the Open Container spec all files should be formatted one sentence per line.
6
6
This fixes two things: it makes diffing easier with git and it resolves fights about line wrapping length.
7
7
For example, this paragraph will span three lines in the Markdown source.
8
8
9
-
## Traditionally hex settings should use JSON integers, not JSON strings
9
+
## <aname="styleHex" />Traditionally hex settings should use JSON integers, not JSON strings
10
10
11
11
For example, [`"classID": 1048577`][class-id] instead of `"classID": "0x100001"`.
12
12
The config JSON isn't enough of a UI to be worth jumping through string <-> integer hoops to support an 0x… form ([source][integer-over-hex]).
13
13
14
-
## Constant names should keep redundant prefixes
14
+
## <aname="styleConstantNames" />Constant names should keep redundant prefixes
15
15
16
16
For example, `CAP_KILL` instead of `KILL` in [**`linux.capabilities`**][capabilities].
17
17
The redundancy reduction from removing the namespacing prefix is not useful enough to be worth trimming the upstream identifier ([source][keep-prefix]).
18
18
19
-
## Optional settings should not have pointer Go types
19
+
## <aname="styleOptionalSettings" />Optional settings should not have pointer Go types
20
20
21
21
Because in many cases the Go default for the type is a no-op in the spec (sources [here][no-pointer-for-strings], [here][no-pointer-for-slices], and [here][no-pointer-for-boolean]).
22
22
The exceptions are entries where we need to distinguish between “not set” and “set to the Go default for that type” ([source][pointer-when-updates-require-changes]), and this decision should be made on a per-setting case.
23
23
24
24
## Examples
25
25
26
-
### Anchoring
26
+
### <aname="styleAnchoring" />Anchoring
27
27
28
28
For any given section that provides a notable example, it is ideal to have it denoted with [markdown headers][markdown-headers].
29
29
The level of header should be such that it is a subheader of the header it is an example of.
@@ -47,7 +47,7 @@ To use Some Topic, ...
47
47
48
48
```
49
49
50
-
### Content
50
+
### <aname="styleContent" />Content
51
51
52
52
Where necessary, the values in the example can be empty or unset, but accommodate with comments regarding this intention.
0 commit comments