docs: fix incorrect information about arg scoping #5381
Merged
Conversation
This file contains 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
tonistiigi
reviewed
Oct 2, 2024
| An `ARG` instruction goes out of scope at the end of the build | ||
| stage where it was defined. To use an argument in multiple stages, each stage must | ||
| include the `ARG` instruction. | ||
| An `ARG` variable declared inside a build stage is automatically inherited by |
There was a problem hiding this comment.
I'm not sure is "downstream build stage" is something that is easily understandable to everyone.
There was a problem hiding this comment.
good callout, I think that term must have bled over from when I was updating the ONBUILD section where we talk about downstream builds. Let me rephrase.
ARGs are inherited by downstream build stages, if declared in a base stage. The documentation ambiguously stated that ARGs are out of scope in other stages, where it really meant other stages that are not child/downstream stages. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
8ebebb3 to
fba1b10
Compare
tonistiigi
approved these changes
Oct 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
ARGs are inherited by downstream build stages, if declared in a base
stage. The documentation ambiguously stated that ARGs are out of scope
in other stages, where it really meant other stages that are not
child/downstream stages.
Signed-off-by: David Karlsson 35727626+dvdksn@users.noreply.github.com