p4u1/docker-cli
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve build cache miss doc for ARG and RUN

Browse Source 
The documentation already says the cache miss happens only at `ARG`
variable usage, not declaration, but there is a very common implicit
usage: `RUN`, which this commit documents even more, improving on #21790.

Also, use `definition` instead of `declaration`: it's the same thing, and
`definition` is already used in this documentation, contrary to
`declaration`.

Also, distinguish between "instructions" and "variables defined by `ARG`
instructions".

Signed-off-by: Thomas Riccardi <riccardi@systran.fr>
Upstream-commit: 6ded7e8279
Component: cli
This commit is contained in:
Thomas Riccardi
2016-04-08 11:23:48 +02:00
committed by Tibor Vass
parent 3ccbcc5dad
commit 591f4efdfb
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
components/cli/docs/reference/builder.md
View File

@ -1174,8 +1174,9 @@ To use these, simply pass them on the command line using the `--build-arg
`ARG` variables are not persisted into the built image as `ENV` variables are.
However, `ARG` variables do impact the build cache in similar ways. If a
Dockerfile defines an `ARG` variable whose value is different from a previous
build, then a "cache miss" occurs upon first use of the `ARG` variable. The
declaration of the `ARG` variable does not count as a use.
build, then a "cache miss" occurs upon its first usage, not its definition. In
particular, all `RUN` instructions following an `ARG` instruction use the `ARG`
variable implicitly (as an environment variable), thus can cause a cache miss.
For example, consider these two Dockerfile: