Fix ENTRYPOINT documentation, drop others. #2138
Conversation
contrib/skopeoimage/README.md
Outdated
| The PATH in the container images is set to the default PATH provided by Fedora. Also, the | ||
| ENTRYPOINT and the WORKDIR variables are not set within these container images, as such they | ||
| default to `/`. | ||
| ENTRYPOINT of the container is set to execute the `skopeo` binary. |
There was a problem hiding this comment.
| ENTRYPOINT of the container is set to execute the `skopeo` binary. | |
| The ENTRYPOINT of the container is set to execute the `skopeo` binary. |
Or, and I'm on the fence about noting the default values or not noting them here as they can be found elsewhere
| ENTRYPOINT of the container is set to execute the `skopeo` binary. | |
| The PATH in the container images is set to the default PATH provided by Fedora, and as it is not set, the WORKDIR variable defaults to `/`. The ENTRYPOINT of the container is set to execute the `skopeo` binary. |
Your call on which to use. I'd go with the lengthier one, but it's a coin flip to me.
There was a problem hiding this comment.
Thanks, fixed the first part.
As for PATH/WORKDIR, the way I think about this (and the way the README documents usage), users are guided to say something like podman run …/skopeo…:latest copy, and not actually do anything inside the container. So PATH/WORKDIR should not matter for such usage. Of course users can execute the container with --entrypoint=/bin/sh… and the Containerfiles do make some effort to make container-storage: work within the container itself.
So it seems to me the question is whether this document is a short introduction to using the image, or whether it is documenting our “API” commitment to have PATH and WORKDIR set that way. I could see an argument for either, I very weakly prefer brevity.
ENTRYPOINT was incorrectly documented to be set to / (which doesn't even make sense). Stop mentioning PATH and WORKDIR in the top-level README, typical users of the container shouldn't need to care, and it's already somewhat implied by "built using the latest Fedora". Fixes containers#2134. Signed-off-by: Miloslav Trmač <mitr@redhat.com>
ENTRYPOINTwas incorrectly documented to be set to/(which doesn't even make sense).Stop mentioning
PATHandWORKDIRin the top-levelREADME, typical users of the container shouldn't need to care, and it's already somewhat implied by "built using the latest Fedora".Fixes #2134.
We should also update the READMEs in some https://quay.io/organization/skopeo repos and https://quay.io/repository/containers/skopeo ; @TomSweeneyRedHat do you know who has write access to that?