Docs: Semiautomatic platform ARGs #2084
Conversation
The `bud` sub-command has been a hidden alias to `build` for quite a while. Fix the documentation accordingly. Signed-off-by: Chris Evich <cevich@redhat.com>
cevich
force-pushed
the
magic_platform_args
branch
3 times, most recently
from
22e4582
to
69922d8
Compare
|
Note: I'm not entirely happy with the way the new header renders in markdown or as a man page. However, it's consistent with the rest of the document (which also renders incomplete/badly). For example anything surrounded by GT/LT characters (like |
|
@edsantiago and @rhatdan I'd love your feedback when you get a chance. This isn't critical, but would be nice to have 😄 |
|
Ephemeral COPR build failed. @containers/packit-build please check. |
docs/Containerfile.5.md
Outdated
| about the host performing the build, and the "TARGET" prefix represents | ||
| the intended platform for the content. | ||
|
|
||
| Each of the following ARG variables must be defined empty before use, |
There was a problem hiding this comment.
I'm still unable to understand what "defined empty" means, even after many rereadings over several hours
There was a problem hiding this comment.
It's a really dumb (Docker) design. You literally put (for example) ARG TARGETARCH in your Containerfile. Forever after that, you can reference ${TARGETARCH} and it will hold the value (for example) amd64 or ppc64le depending on what platform the build is happening for.
I think this is a good suggestion, but I'm slightly confused with the wording. Do you mean, target a reader familiar with the use of |
All/most markdown renderers will mask any naked `<` and `>` characters that appear in the plain text. This was making the documented syntax of the `ARG` command unintelligible. Fix this. Signed-off-by: Chris Evich <cevich@redhat.com>
Available for quite some time, but often useful and undocumented. Fix that and a minor whitespace problem. Signed-off-by: Chris Evich <cevich@redhat.com>
cevich
force-pushed
the
magic_platform_args
branch
from
69922d8
to
c314c91
Compare
|
Force-push: Hopefully this addresses Ed's concerns. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: cevich, edsantiago, flouthoc 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 |
|
/lgtm |
Available for quite some time, but often useful and undocumented.
Fix that and a minor whitespace problem.
Also (minor), rename "buildah bud" to "buildah build".
Fixes: #1935
Ref. Dockerfile docs