Dockerfile: update comments #2852
Conversation
| @@ -6,14 +6,15 @@ ARG CONTAINERD_VERSION=v1.6.3 | |||
| ARG CONTAINERD_ALT_VERSION_15=v1.5.11 | |||
| # containerd v1.4 for integration tests | |||
| ARG CONTAINERD_ALT_VERSION_14=v1.4.13 | |||
| # available targets: buildkitd, buildkitd.oci_only, buildkitd.containerd_only | |||
| # BUILDKIT_TARGET defines buildkitd worker mode (buildkitd, buildkitd.oci_only, buildkitd.containerd_only) | |||
There was a problem hiding this comment.
So IIUC, "outline" uses a GoDoc-like approach <thing> does <x> and ignores other comments? Or are they still printed even if they don't start with <thing> (name of ARG)? #2841
We should probably document that somewhere that that's the convention to use (perhaps we can borrow some of the description from Golang)
There was a problem hiding this comment.
I think #2841 takes whatever comment is put for an arg or stage as description. I agree that we should have a markup like GoDoc. See #2841 (comment) for a use case.
There was a problem hiding this comment.
Gotcha; makes sense.
I guess with the ARGNAME <description> approach, we'd be able to have separate descriptions for arguments, even if multiple are defined at once (ARG ONE=one TWO=two)
There was a problem hiding this comment.
Same as Godoc. Applies to args and stages.
There was a problem hiding this comment.
Signed-off-by: Tonis Tiigi <[email protected]>
tonistiigi
force-pushed
the
dockerfile-comments-upt
branch
from
b0698a6 to
50e677e
Compare
Improve Dockerfile after testing outline with #2841
Signed-off-by: Tonis Tiigi [email protected]