Update ARG sytnax definition in dockerfile reference #5427
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
Signed-off-by: Shaun Thompson <shaun.thompson@docker.com>
dvdksn
approved these changes
Oct 15, 2024
tonistiigi
approved these changes
Oct 15, 2024
thaJeztah
reviewed
Oct 15, 2024
| @@ -2310,7 +2310,7 @@ Therefore, to avoid unintended operations in unknown directories, it's best prac | |||
| ## ARG | |||
|
|
|||
| ```dockerfile | |||
| ARG <name>[=<default value>] | |||
| ARG <name>[=<default value>] ... | |||
There was a problem hiding this comment.
Wondering if the more correct presentation of this would be (more clearly indicating that the first key/value is required, and more are optional);
Suggested change
| ARG <name>[=<default value>] ... | |
| ARG <name>[=<default value>] [<name>[=<default value>]...] |
Similar to how (e.g.) we do for docker stop and docker service scale;
docker stop --help
Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...]docker service scale --help
Usage: docker service scale SERVICE=REPLICAS [SERVICE=REPLICAS...]There was a problem hiding this comment.
I guess your suggestion is more correct but this was also the variant used in ENV and LABEL. So modifications should be done together then.
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.
Small update to the
ARGsyntax definition in the reference document. It should now reflect the ability to have multipleARGs declared on a single line.