Skip to content

Commit

Permalink
Merge pull request moby#5427 from thompson-shaun/update-dockerfile-re…
Browse files Browse the repository at this point in the history 
…f-arg

Update ARG sytnax definition in dockerfile reference
  • Loading branch information
@tonistiigi
tonistiigi authored Oct 15, 2024
2 parents a7656ae + 3a6e923 commit 4b4a9aa
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions frontend/dockerfile/docs/reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -728,7 +728,7 @@ This can be used to:
The supported mount types are:

| Type | Description |
| ---------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| [`bind`](#run---mounttypebind) (default) | Bind-mount context directories (read-only). |
| [`cache`](#run---mounttypecache) | Mount a temporary directory to cache directories for compilers and package managers. |
| [`tmpfs`](#run---mounttypetmpfs) | Mount a `tmpfs` in the build container. |
Expand All @@ -741,7 +741,7 @@ This mount type allows binding files or directories to the build container. A
bind mount is read-only by default.

| Option | Description |
| ---------------- | ---------------------------------------------------------------------------------------------- |
| ---------------------------------- | ---------------------------------------------------------------------------------------------- |
| `target`, `dst`, `destination`[^1] | Mount path. |
| `source` | Source path in the `from`. Defaults to the root of the `from`. |
| `from` | Build stage, context, or image name for the root of the source. Defaults to the build context. |
Expand All @@ -753,7 +753,7 @@ This mount type allows the build container to cache directories for compilers
and package managers.

| Option | Description |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | Optional ID to identify separate/different caches. Defaults to value of `target`. |
| `target`, `dst`, `destination`[^1] | Mount path. |
| `ro`,`readonly` | Read-only if set. |
Expand Down Expand Up @@ -802,7 +802,7 @@ case.
This mount type allows mounting `tmpfs` in the build container.

| Option | Description |
| ------------ | ----------------------------------------------------- |
| ---------------------------------- | ----------------------------------------------------- |
| `target`, `dst`, `destination`[^1] | Mount path. |
| `size` | Specify an upper limit on the size of the filesystem. |

Expand Down Expand Up @@ -863,7 +863,7 @@ This mount type allows the build container to access SSH keys via SSH agents,
with support for passphrases.

| Option | Description |
| ---------- | ---------------------------------------------------------------------------------------------- |
| ------------------------------ | ---------------------------------------------------------------------------------------------- |
| `id` | ID of SSH agent socket or key. Defaults to "default". |
| `target`, `dst`, `destination` | SSH agent socket path. Defaults to `/run/buildkit/ssh_agent.${N}`. |
| `required` | If set to `true`, the instruction errors out when the key is unavailable. Defaults to `false`. |
Expand Down Expand Up @@ -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>] ...
```

The `ARG` instruction defines a variable that users can pass at build-time to
Expand Down

0 comments on commit 4b4a9aa

Please sign in to comment.