summaryrefslogtreecommitdiff
path: root/vendor/github.com/opencontainers/go-digest/doc.go
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2020-05-21 19:30:10 +0200
committerGitHub <noreply@github.com>2020-05-21 19:30:10 +0200
commit9eb6c3056398c3776018eccd121ac487a9282c36 (patch)
tree19b3d53d54b92ae28372b656ab1ff21fe10e645e /vendor/github.com/opencontainers/go-digest/doc.go
parent17553caca453b3ca24ad3e5f1c15ffeaad87030a (diff)
parent7ccf5708dac7a2d8d1ea89a5d165f12e11d01131 (diff)
downloadpodman-9eb6c3056398c3776018eccd121ac487a9282c36.tar.gz
podman-9eb6c3056398c3776018eccd121ac487a9282c36.tar.bz2
podman-9eb6c3056398c3776018eccd121ac487a9282c36.zip
Merge pull request #6314 from containers/dependabot/go_modules/github.com/containers/storage-1.20.1
Bump github.com/containers/storage from 1.19.2 to 1.20.1
Diffstat (limited to 'vendor/github.com/opencontainers/go-digest/doc.go')
-rw-r--r--vendor/github.com/opencontainers/go-digest/doc.go10
1 files changed, 8 insertions, 2 deletions
diff --git a/vendor/github.com/opencontainers/go-digest/doc.go b/vendor/github.com/opencontainers/go-digest/doc.go
index 491ea1ef1..83d3a936c 100644
--- a/vendor/github.com/opencontainers/go-digest/doc.go
+++ b/vendor/github.com/opencontainers/go-digest/doc.go
@@ -1,3 +1,4 @@
+// Copyright 2019, 2020 OCI Contributors
// Copyright 2017 Docker, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
@@ -29,8 +30,13 @@
//
// sha256:7173b809ca12ec5dee4506cd86be934c4596dd234ee82c0662eac04a8c2c71dc
//
-// In this case, the string "sha256" is the algorithm and the hex bytes are
-// the "digest".
+// The "algorithm" portion defines both the hashing algorithm used to calculate
+// the digest and the encoding of the resulting digest, which defaults to "hex"
+// if not otherwise specified. Currently, all supported algorithms have their
+// digests encoded in hex strings.
+//
+// In the example above, the string "sha256" is the algorithm and the hex bytes
+// are the "digest".
//
// Because the Digest type is simply a string, once a valid Digest is
// obtained, comparisons are cheap, quick and simple to express with the