From d0f90e68158b19ec241969d87200a1ec268c4df6 Mon Sep 17 00:00:00 2001 From: Brandon Mitchell Date: Thu, 25 Jan 2024 14:38:36 -0500 Subject: [PATCH] Clarify that subject references a separate DAG Signed-off-by: Brandon Mitchell --- image-index.md | 13 +++++++------ manifest.md | 10 ++++++---- 2 files changed, 13 insertions(+), 10 deletions(-) diff --git a/image-index.md b/image-index.md index c661760a5..1cf16f647 100644 --- a/image-index.md +++ b/image-index.md @@ -93,7 +93,7 @@ For the media type(s) that this document is compatible with, see the [matrix][ma - **`subject`** *[descriptor](descriptor.md)* This OPTIONAL property specifies a [descriptor](descriptor.md) of another manifest. - This value, used by the [`referrers` API][referrers-api], indicates a relationship to the specified manifest. + This value defines a weak association to a separate [Merkle Directed Acyclic Graph (DAG)][dag] structure, and is used by the [`referrers` API][referrers-api] to include this manifest in the list of responses for the subject digest. - **`annotations`** *string-string map* @@ -179,9 +179,10 @@ When the variant of the CPU is not listed in the table, values are implementatio } ``` +[dag]: https://en.wikipedia.org/wiki/Merkle_tree [go-environment2]: https://golang.org/doc/install/source#environment -[iana]: https://www.iana.org/assignments/media-types/media-types.xhtml -[matrix]: media-types.md#compatibility-matrix -[referrers-api]: https://github.com/opencontainers/distribution-spec/blob/main/spec.md#listing-referrers -[rfc6838]: https://tools.ietf.org/html/rfc6838 -[rfc6838-s4.2]: https://tools.ietf.org/html/rfc6838#section-4.2 +[iana]: https://www.iana.org/assignments/media-types/media-types.xhtml +[matrix]: media-types.md#compatibility-matrix +[referrers-api]: https://github.com/opencontainers/distribution-spec/blob/main/spec.md#listing-referrers +[rfc6838]: https://tools.ietf.org/html/rfc6838 +[rfc6838-s4.2]: https://tools.ietf.org/html/rfc6838#section-4.2 diff --git a/manifest.md b/manifest.md index 983941612..ea0468631 100644 --- a/manifest.md +++ b/manifest.md @@ -94,7 +94,7 @@ Unlike the [image index](image-index.md), which contains information about a set - **`subject`** *[descriptor](descriptor.md)* This OPTIONAL property specifies a [descriptor](descriptor.md) of another manifest. - This value, used by the [`referrers` API](https://github.com/opencontainers/distribution-spec/blob/main/spec.md#listing-referrers), indicates a relationship to the specified manifest. + This value defines a weak association to a separate [Merkle Directed Acyclic Graph (DAG)][dag] structure, and is used by the [`referrers` API][referrers-api] to include this manifest in the list of responses for the subject digest. - **`annotations`** *string-string map* @@ -257,6 +257,8 @@ The decision tree below and the associated examples MAY be used to design new ar _Implementers note:_ artifacts have historically been created without an `artifactType` field, and tooling to work with artifacts should fallback to the `config.mediaType` value. -[iana]: https://www.iana.org/assignments/media-types/media-types.xhtml -[rfc6838]: https://tools.ietf.org/html/rfc6838 -[rfc6838-s4.2]: https://tools.ietf.org/html/rfc6838#section-4.2 +[dag]: https://en.wikipedia.org/wiki/Merkle_tree +[iana]: https://www.iana.org/assignments/media-types/media-types.xhtml +[referrers-api]: https://github.com/opencontainers/distribution-spec/blob/main/spec.md#listing-referrers +[rfc6838]: https://tools.ietf.org/html/rfc6838 +[rfc6838-s4.2]: https://tools.ietf.org/html/rfc6838#section-4.2