docs icon indicating copy to clipboard operation
docs copied to clipboard

Document supported checksum digest algorithm

Open gilbertbw opened this issue 1 year ago • 5 comments

Is this a docs issue?

  • [X] My issue is about the documentation content or website

Type of issue

I can't find what I'm looking for

Description

The --checksum option for the ADD command does not indicate what digests are supported.

Location

https://docs.docker.com/engine/reference/builder/

Suggestion

Document the digests that are supported. n.b. I could not find the relevant source code for this.

gilbertbw avatar Nov 15 '23 14:11 gilbertbw

I'd add to better document the error you get when the digest algorithm is unsupported. I tried ADD --checksum:md5 and the error I was getting from a docker compose build command was "unsupported digest algorithm", which IMO is not very clear. I didn't even know it was about the ADD command, and I was digging around the image digest for a good bit before thinking of looking at the ADD command.

fcharron avatar Nov 22 '23 07:11 fcharron

There hasn't been any activity on this issue for a long time. If the problem is still relevant, mark the issue as fresh with a /remove-lifecycle stale comment. If not, this issue will be closed in 14 days. This helps our maintainers focus on the active issues.

Prevent issues from auto-closing with a /lifecycle frozen comment.

/lifecycle stale

docker-robot[bot] avatar Mar 15 '24 01:03 docker-robot[bot]

I believe this is really needed! It's not clear which algorithms are supported

thiagomarafeli avatar Mar 25 '24 21:03 thiagomarafeli

/remove-lifecycle stale This is still not documented

gilbertbw avatar Mar 27 '24 12:03 gilbertbw