Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve transport documentation #2042

Merged
merged 4 commits into from
Jul 22, 2023
Merged

Conversation

mtrmac
Copy link
Collaborator

@mtrmac mtrmac commented Jul 15, 2023

… in containers-transports(5) and containers-policy.json(5).

See individual commit messages for a bit more detail.

Fixes #1501 .

@mtrmac mtrmac added the kind/bug A defect in an existing functionality (or a PR fixing it) label Jul 15, 2023
Copy link
Member

@vrothberg vrothberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

- a named Docker reference *in the fully expanded form*, either using a tag or digest. For example, `docker.io/library/busybox:latest` (*not* `busybox:latest`)
- and/or (depending on which one the user’s input provides) `@`_image-id_

More general scopes are prefixes of individual-image scopes, and specify a less-precisly-specified image, or a repository
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
More general scopes are prefixes of individual-image scopes, and specify a less-precisly-specified image, or a repository
More general scopes are prefixes of individual-image scopes, and specify a less-precisely-specified image, or a repository

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Fixed.

@TomSweeneyRedHat
Copy link
Member

One small typo, otherwise LGTM.

mtrmac added 4 commits July 19, 2023 20:25
- Separate the code imports from transport-registration imports
- Improve the comment about updating documentation
- Add a missing comment about docker-daemon
- Sort transports, and transport comments alphabetically.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
... to match the 2017 docker/reference API migration.

Should not change behavior.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
- Add missing sif:
- Add comments about intentionally-excluded atomic: and tarball:
- docker-archive: can now transparently handle non-seekable streams
- Clarify documentation of references in OCI transports

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
…cy.json(5)

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
@rhatdan
Copy link
Member

rhatdan commented Jul 22, 2023

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug A defect in an existing functionality (or a PR fixing it)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add missing end-user transport documentation
4 participants