Skip to content

Commit df12019

Browse files
authored
Merge pull request #559 from vbatts/carry_pr497
Carry pr497
2 parents e4c7ecd + 51d3d1a commit df12019

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

spec.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
# Open Container Initiative Image Format Specification
1+
# Open Container Initiative
2+
## Image Format Specification
23

34
This specification defines an OCI Image, consisting of a [manifest](manifest.md), a [manifest list](manifest-list.md) (optional), a set of [filesystem layers](layer.md), and a [configuration](config.md).
45

56
The goal of this specification is to enable the creation of interoperable tools for building, transporting, and preparing a container image to run.
67

7-
## Table of Contents
8+
### Table of Contents
89

910
- [Introduction](spec.md)
1011
- [Notational Conventions](#notational-conventions)
@@ -22,7 +23,7 @@ The goal of this specification is to enable the creation of interoperable tools
2223
- [Extensibility](considerations.md#extensibility)
2324
- [Canonicalization](considerations.md#canonicalization)
2425

25-
# Notational Conventions
26+
## Notational Conventions
2627

2728
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](http://tools.ietf.org/html/rfc2119) (Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997).
2829

@@ -31,7 +32,7 @@ The key words "unspecified", "undefined", and "implementation-defined" are to be
3132
An implementation is not compliant if it fails to satisfy one or more of the MUST, REQUIRED, or SHALL requirements for the protocols it implements.
3233
An implementation is compliant if it satisfies all the MUST, REQUIRED, and SHALL requirements for the protocols it implements.
3334

34-
# Overview
35+
## Overview
3536

3637
At a high level the image manifest contains metadata about the contents and dependencies of the image including the content-addressable identity of one or more [filesystem layer changeset](layer.md) archives that will be unpacked to make up the final runnable filesystem.
3738
The image configuration includes information such as application arguments, environments, etc.
@@ -44,7 +45,7 @@ Once built the OCI Image can then be discovered by name, downloaded, verified by
4445

4546
![](img/run-diagram.png)
4647

47-
## Understanding the Specification
48+
### Understanding the Specification
4849

4950
The [OCI Image Media Types](media-types.md) document is a starting point to understanding the overall structure of the specification.
5051

0 commit comments

Comments
 (0)