README: Consolidate "OCI Image" definitions #456
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These two sentences had been saying pretty much the same thing. The first had previously scoped the spec to image creation, but the spec covers the format itself, creation, and unpacking. Listing the constituent components seemed like enough for one sentence, so the new sentence stays away from format/creation/unpacking distinctions. I've also left manifest lists out for now, since adding a reference too them seemed orthogonal do consolidating these sentences. Signed-off-by: W. Trevor King <[email protected]>
jonboulle
reviewed
Nov 11, 2016
| @@ -19,10 +19,9 @@ The goal of this specification is to enable the creation of interoperable tools | |||
|
|
|||
| ## Overview | |||
|
|
|||
| This specification defines how to create an OCI Image, which will generally be done by a build system, and output an [image manifest](manifest.md), a set of [filesystem layers](layer.md), and an [image configuration](config.md). | |||
| This specification defines an OCI Image, consisting of a [manifest](manifest.md), a set of [filesystem layers](layer.md), and a [configuration](config.md). | |||
| 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. | |||
There was a problem hiding this comment.
Can we strike "At a high level"?
There was a problem hiding this comment.
I'm fine with that change, but am not touching the line in this PR. Maybe ask in #455 (which is touching the line)?
This was referenced Nov 14, 2016
|
LGTM |
|
lgtm |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These two sentences had been saying pretty much the same thing. The first had previously scoped the spec to image creation, but the spec covers the format itself, creation, and unpacking. Listing the constituent components seemed like enough for one sentence, so the new sentence stays away from format/creation/unpacking distinctions.
I've also left manifest lists out for now, since adding a reference too them seemed orthogonal do consolidating these sentences. Adding manifest-list references is covered in #455.