Skip to content

Commit ffccb32

Browse files
committed
Update references to c/image in documentation and texts
Should not change behavior. Signed-off-by: Miloslav Trmač <[email protected]>
1 parent 67d23a3 commit ffccb32

File tree

6 files changed

+10
-10
lines changed

6 files changed

+10
-10
lines changed

image/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,11 @@ or use the build tags described below to avoid the dependencies (e.g. using `go
5757

5858
### Supported build tags
5959

60-
- `containers_image_docker_daemon_stub`: Don’t import the `docker-daemon:` transport in `github.com/containers/image/transports/alltransports`, to decrease the amount of required dependencies. Use a stub which reports that the transport is not supported instead.
60+
- `containers_image_docker_daemon_stub`: Don’t import the `docker-daemon:` transport in `go.podman.io/image/v5/transports/alltransports`, to decrease the amount of required dependencies. Use a stub which reports that the transport is not supported instead.
6161
- `containers_image_openpgp`: Use a Golang-only OpenPGP implementation for signature verification instead of the default cgo/gpgme-based implementation;
6262
the primary downside is that creating new signatures with the Golang-only implementation is not supported.
6363
- `containers_image_sequoia`: Use Sequoia-PGP for signature verification instead of the default cgo/gpgme-based or the Golang-only OpenPGP implementations, and enable the `signature/simplesequoia` subpackage. This requires a support shared library installed on the system. Install https://github.com/ueno/podman-sequoia , and potentially update build configuration to point at it (compare `SEQUOIA_SONAME_DIR` in `Makefile`).
64-
- `containers_image_storage_stub`: Don’t import the `containers-storage:` transport in `github.com/containers/image/transports/alltransports`, to decrease the amount of required dependencies. Use a stub which reports that the transport is not supported instead.
64+
- `containers_image_storage_stub`: Don’t import the `containers-storage:` transport in `go.podman.io/image/v5/transports/alltransports`, to decrease the amount of required dependencies. Use a stub which reports that the transport is not supported instead.
6565

6666
## [Contributing](CONTRIBUTING.md)
6767

image/docker/tarfile/doc.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
// Package tarfile is an internal implementation detail of some transports.
2-
// Do not use outside of the github.com/containers/image repo!
2+
// Do not use outside of the go.podman.io/image repo!
33
package tarfile

image/docs/atomic-signature-embedded-json.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"title": "JSON embedded in an atomic container signature",
3-
"description": "This schema is a supplement to atomic-signature.md in this directory.\n\nConsumers of the JSON MUST use the processing rules documented in atomic-signature.md, especially the requirements for the 'critical' subobject.\n\nWhenever this schema and atomic-signature.md, or the github.com/containers/image/signature implementation, differ,\nit is the atomic-signature.md document, or the github.com/containers/image/signature implementation, which governs.\n\nUsers are STRONGLY RECOMMENDED to use the github.com/containers/image/signature implementation instead of writing\ntheir own, ESPECIALLY when consuming signatures, so that the policy.json format can be shared by all image consumers.\n",
3+
"description": "This schema is a supplement to atomic-signature.md in this directory.\n\nConsumers of the JSON MUST use the processing rules documented in atomic-signature.md, especially the requirements for the 'critical' subobject.\n\nWhenever this schema and atomic-signature.md, or the go.podman.io/image/v5/signature implementation, differ,\nit is the atomic-signature.md document, or the go.podman.io/image/v5/signature implementation, which governs.\n\nUsers are STRONGLY RECOMMENDED to use the go.podman.io/image/v5/signature implementation instead of writing\ntheir own, ESPECIALLY when consuming signatures, so that the policy.json format can be shared by all image consumers.\n",
44
"type": "object",
55
"required": [
66
"critical",

image/docs/containers-signature.5.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ container-signature - Container signature format
77

88
# DESCRIPTION
99
This document describes the format of container signatures,
10-
as implemented by the `github.com/containers/image/signature` package.
10+
as implemented by the `go.podman.io/image/v5/signature` package.
1111

12-
Most users should be able to consume these signatures by using the `github.com/containers/image/signature` package
12+
Most users should be able to consume these signatures by using the `go.podman.io/image/v5/signature` package
1313
(preferably through the higher-level `signature.PolicyContext` interface)
1414
without having to care about the details of the format described below.
1515
This documentation exists primarily for maintainers of the package
@@ -65,7 +65,7 @@ or in any way usable for making policy decisions about the image.)
6565

6666
When verifying a cryptographic signature in the OpenPGP format,
6767
the consumer MUST verify at least the following aspects of the signature
68-
(like the `github.com/containers/image/signature` package does):
68+
(like the `go.podman.io/image/v5/signature` package does):
6969

7070
- The blob MUST be a “Signed Message” as defined RFC 4880 section 11.3.
7171
(e.g. it MUST NOT be an unsigned “Literal Message”,

image/docs/signature-protocols.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Signature access protocols
22

3-
The `github.com/containers/image` library supports signatures implemented as blobs “attached to” an image.
3+
The `go.podman.io/image/v5` library supports signatures implemented as blobs “attached to” an image.
44
Some image transports (local storage formats and remote protocols) implement these signatures natively
55
or trivially; for others, the protocol extensions described below are necessary.
66

image/signature/mechanism_openpgp.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,13 +112,13 @@ func (m *openpgpSigningMechanism) importKeysFromBytes(blob []byte) ([]string, er
112112

113113
// SupportsSigning returns nil if the mechanism supports signing, or a SigningNotSupportedError.
114114
func (m *openpgpSigningMechanism) SupportsSigning() error {
115-
return SigningNotSupportedError("signing is not supported in github.com/containers/image built with the containers_image_openpgp build tag")
115+
return SigningNotSupportedError("signing is not supported in go.podman.io/image built with the containers_image_openpgp build tag")
116116
}
117117

118118
// Sign creates a (non-detached) signature of input using keyIdentity.
119119
// Fails with a SigningNotSupportedError if the mechanism does not support signing.
120120
func (m *openpgpSigningMechanism) SignWithPassphrase(input []byte, keyIdentity string, passphrase string) ([]byte, error) {
121-
return nil, SigningNotSupportedError("signing is not supported in github.com/containers/image built with the containers_image_openpgp build tag")
121+
return nil, SigningNotSupportedError("signing is not supported in go.podman.io/image built with the containers_image_openpgp build tag")
122122
}
123123

124124
// Sign creates a (non-detached) signature of input using keyIdentity.

0 commit comments

Comments
 (0)