Skip to content

Commit

Permalink
Merge pull request #526 from wking/dry-annotations
Browse files Browse the repository at this point in the history
considerations: DRY extensibility
  • Loading branch information
vbatts authored Jan 25, 2017
2 parents 111a99d + f760279 commit 236640a
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 10 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ DOC_FILES := \
layer.md \
config.md \
annotations.md \
canonicalization.md
considerations.md

FIGURE_FILES := \
img/media-types.png
Expand Down
5 changes: 5 additions & 0 deletions canonicalization.md → considerations.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# Extensibility

Implementations that are reading/processing [manifests](manifest.md) or [manifest lists](manifest-list.md) MUST NOT generate an error if they encounter an unknown property.
Instead they MUST ignore unknown properties.

# Canonicalization

OCI Images [are](descriptor.md) [content-addressable](image-layout.md).
Expand Down
4 changes: 0 additions & 4 deletions manifest-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,6 @@ For the media type(s) that this document is compatible with, see the [matrix][ma

See [Pre-Defined Annotation Keys](annotations.md#pre-defined-annotation-keys).

### Extensibility
Implementations that are reading/processing manifest lists MUST NOT generate an error if they encounter an unknown property.
Instead they MUST ignore unknown properties.

## Example Manifest List

*Example showing a simple manifest list pointing to image manifests for two platforms:*
Expand Down
4 changes: 0 additions & 4 deletions manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,6 @@ Unlike the [Manifest List](manifest-list.md), which contains information about a

See [Pre-Defined Annotation Keys](annotations.md#pre-defined-annotation-keys).

### Extensibility
Implementations that are reading/processing image manifests MUST NOT generate an error if they encounter an unknown property.
Instead they MUST ignore unknown properties.

## Example Image Manifest

*Example showing an image manifest:*
Expand Down
4 changes: 3 additions & 1 deletion spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ The goal of this specification is to enable the creation of interoperable tools
- [Filesystem Layers](layer.md)
- [Image Configuration](config.md)
- [Annotations](annotations.md)
- [Canonicalization](canonicalization.md)
- [Considerations](considerations.md)
- [Extensibility](considerations.md#extensibility)
- [Canonicalization](considerations.md#canonicalization)

# Notational Conventions

Expand Down

0 comments on commit 236640a

Please sign in to comment.