[CI:DOCS] Touch up Containerfile man page to show ARG can be 1st #3577
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
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: TomSweeneyRedHat The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
rhatdan
reviewed
Oct 8, 2021
docs/Containerfile.5.md
Outdated
| valid image. It is easy to start by pulling an image from the public | ||
| valid Containerfile must have either **ARG** or *FROM** as its first instruction. | ||
| If **FROM** is not the first instruction in the file, it may only be preceded by | ||
| one or more ARG instructions, which declare arguments that are used in FROM lines in the Containerfile. |
There was a problem hiding this comment.
Just to nitpick, aren't ARGs only used by the next FROM command. IE
ARG FOO=bar
from fedora
from $FOO
Does not work. From reading this description, I would assume it does.
There was a problem hiding this comment.
That's a good nit to pick. Perhaps "... are used in the next FROM line in the Containerfile."
The Containerfile man page says FROM must be the first statement in the file. However, that is not true as the ARG instruction can proceed it. Addresses: containers#3555 Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
TomSweeneyRedHat
force-pushed
the
dev/tsweeney/cign2
branch
from
5492729
to
a5b5534
Compare
|
/lgtm |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The Containerfile man page says FROM must be the first statement
in the file. However, that is not true as the ARG instruction can proceed it.
Fixes: #3555
Signed-off-by: TomSweeneyRedHat tsweeney@redhat.com
What type of PR is this?
What this PR does / why we need it:
Fixes the Containerfile man page which stated FROM had to be the first instruction, when it is permissible to have ARG.
How to verify it
Read
Which issue(s) this PR fixes:
Special notes for your reviewer:
Does this PR introduce a user-facing change?