From a8022da9cf6132c1c9e757549bf59bf0c50b4f9d Mon Sep 17 00:00:00 2001 From: "Rob Dolin (MSFT)" Date: Wed, 14 Dec 2016 09:45:38 -0800 Subject: [PATCH 1/2] [Spec.md] Split title onto two lines This should fix the hyphenation of the word "Specification" in the PDF version. Signed-off-by: Rob Dolin --- spec.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/spec.md b/spec.md index fdffd0e8b..c23e8ca71 100644 --- a/spec.md +++ b/spec.md @@ -1,4 +1,5 @@ -# Open Container Initiative Image Format Specification +# Open Container Initiative +# Image Format Specification 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). From 51d3d1aa2c39c2fdc9406b94a8c507ad84c864c7 Mon Sep 17 00:00:00 2001 From: Vincent Batts Date: Wed, 8 Feb 2017 10:20:08 -0500 Subject: [PATCH 2/2] spec: step down the headings Signed-off-by: Vincent Batts --- spec.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/spec.md b/spec.md index c23e8ca71..d8f424839 100644 --- a/spec.md +++ b/spec.md @@ -1,11 +1,11 @@ # Open Container Initiative -# Image Format Specification +## Image Format Specification 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). The goal of this specification is to enable the creation of interoperable tools for building, transporting, and preparing a container image to run. -## Table of Contents +### Table of Contents - [Introduction](spec.md) - [Notational Conventions](#notational-conventions) @@ -23,7 +23,7 @@ The goal of this specification is to enable the creation of interoperable tools - [Extensibility](considerations.md#extensibility) - [Canonicalization](considerations.md#canonicalization) -# Notational Conventions +## Notational Conventions 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). @@ -32,7 +32,7 @@ The key words "unspecified", "undefined", and "implementation-defined" are to be 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. An implementation is compliant if it satisfies all the MUST, REQUIRED, and SHALL requirements for the protocols it implements. -# Overview +## Overview 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. The image configuration includes information such as application arguments, environments, etc. @@ -45,7 +45,7 @@ Once built the OCI Image can then be discovered by name, downloaded, verified by ![](img/run-diagram.png) -## Understanding the Specification +### Understanding the Specification The [OCI Image Media Types](media-types.md) document is a starting point to understanding the overall structure of the specification.