Document extensibility of the image layout #1230
Open
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
Signed-off-by: Brandon Mitchell <[email protected]>
sudo-bmitch
requested review from
jonjohnsonjr,
stevvooe,
sajayantony,
tianon and
cyphar
as code owners
thaJeztah
approved these changes
Dec 23, 2024
Comment on lines
+34
to
+35
| Implementations should not error when encountering unknown files. | ||
| A common usage includes the `manifest.json` file associated with a saved docker image. |
There was a problem hiding this comment.
Not sure if we do elsewhere, but was wondering if there's value in outlining "why" ("To allow future expansion, and to allow backward compatibility with older specifications").
tianon
reviewed
Dec 23, 2024
| **Implementor's Note:** | ||
| Additional files may be included in the directory. | ||
| Implementations should not error when encountering unknown files. | ||
| A common usage includes the `manifest.json` file associated with a saved docker image. |
There was a problem hiding this comment.
Suggested change
| A common usage includes the `manifest.json` file associated with a saved docker image. | |
| A common usage includes the `manifest.json` file associated with a saved Docker image. |
We could add a reference for this file too, but I don't think that's actually important. 👍
Another alternative to resolve the proper noun in a different way:
Suggested change
| A common usage includes the `manifest.json` file associated with a saved docker image. | |
| A common usage includes the `manifest.json` file associated with the older `docker save` format (for backwards compatibility). |
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.
Implementations have been seen that error if a
manifest.jsonis included inside the OCI Layout. This documents the extensibility of the directory structure.See moby/moby#49141