assorted dockerfile docs issues#6582
Merged
crazy-max merged 10 commits intomoby:masterfrom Mar 17, 2026
Merged
Conversation
dvdksn
force-pushed
the
assorted-dockerfile-docs-issues
branch
from
e756e8c to
2f6075d
Compare
Member
|
Should probably remove the |
Member
Each issue should be prefixed with |
Member
I think GitHub doesn't look at commit message to close related issue but PR description. |
Member
|
it looks at both 😅 |
Member
From the UI seems it only closes one: docker/docs#14233 
|
…lacement
Add documentation for the `${variable-word}` and `${variable+word}`
modifiers which differ from their colon counterparts (`${variable:-word}`
and `${variable:+word}`) in that they only test whether the variable is
unset, rather than unset or empty.
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
In multi-stage builds, labels from intermediate stages referenced via COPY --from or RUN --mount=from= are not included in the final output image. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
The FROM instruction description mentioned that a named stage can be referenced in subsequent FROM instructions, but lacked a concrete example demonstrating this common multi-stage pattern. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
STOPSIGNAL only affects the signal sent by docker stop (and the Docker daemon). Keyboard shortcuts like Ctrl+C send SIGINT directly, independent of the STOPSIGNAL setting. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
The previous text said "use either form of CMD" which is technically true but misleading. When using exec ENTRYPOINT, shell-form CMD wraps the command in /bin/sh -c, which means ENTRYPOINT receives a shell invocation rather than the bare arguments. Exec form CMD is the expected pairing. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Replace "prevents CMD command line arguments from being used" with "ignores CMD and docker run command line arguments", which more accurately describes the behavior: the arguments are not absent, they just aren't forwarded to the command inside /bin/sh -c. Also align with the wording used in the Shell form ENTRYPOINT example section further down. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
The terse note "Written data will be discarded" was unexplained. Expand it to clarify that writes are discarded when the RUN instruction completes and are not committed to the image layer. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
The --parents section only showed simple wildcard examples. Add an example demonstrating the ** glob pattern, which recursively matches files across directory levels and is particularly useful with --parents to preserve deep directory structures. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
The description of when health checks run was incomplete. During the start period, checks run at start-interval frequency (default 5s), not at the regular interval (default 30s). Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
When migrating from legacy multi-line ENV/ARG syntax to the modern key=value format, leading whitespace on continuation lines is preserved in both syntaxes. Add a note making this explicit so users understand they may need to adjust indentation when converting. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
dvdksn
force-pushed
the
assorted-dockerfile-docs-issues
branch
from
2f6075d to
2016c37
Compare
Collaborator
Author
|
are you happy now @thaJeztah @crazy-max 😆 |
Collaborator
Author
|
feel free to merge - I don't have write access. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
related issues
Fixes docker/docs#14233
Fixes docker/docs#20549
Fixes docker/docs#22940
Fixes docker/docs#23122
Fixes docker/docs#23140
Fixes docker/docs#23165
Fixes docker/docs#23285
Fixes docker/docs#24096
Fixes docker/docs#24308
Fixes docker/docs#24227