Skip to content

Commit 719f88e

Browse files
committed
docs: regenerate markdown
Signed-off-by: David Karlsson <[email protected]>
1 parent 75ffd77 commit 719f88e

96 files changed

Lines changed: 315 additions & 315 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/reference/commandline/attach.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Attach local standard input, output, and error streams to a running container
1212
| Name | Type | Default | Description |
1313
|:----------------|:---------|:--------|:----------------------------------------------------|
1414
| `--detach-keys` | `string` | | Override the key sequence for detaching a container |
15-
| `--no-stdin` | | | Do not attach STDIN |
15+
| `--no-stdin` | `bool` | | Do not attach STDIN |
1616
| `--sig-proxy` | `bool` | `true` | Proxy all received signals to the process |
1717

1818

docs/reference/commandline/build.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,29 +15,29 @@ Build an image from a Dockerfile
1515
| `--build-arg` | `list` | | Set build-time variables |
1616
| `--cache-from` | `stringSlice` | | Images to consider as cache sources |
1717
| `--cgroup-parent` | `string` | | Set the parent cgroup for the `RUN` instructions during build |
18-
| `--compress` | | | Compress the build context using gzip |
18+
| `--compress` | `bool` | | Compress the build context using gzip |
1919
| `--cpu-period` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) period |
2020
| `--cpu-quota` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) quota |
2121
| `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) |
2222
| `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) |
2323
| `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) |
2424
| `--disable-content-trust` | `bool` | `true` | Skip image verification |
2525
| `-f`, `--file` | `string` | | Name of the Dockerfile (Default is `PATH/Dockerfile`) |
26-
| `--force-rm` | | | Always remove intermediate containers |
26+
| `--force-rm` | `bool` | | Always remove intermediate containers |
2727
| `--iidfile` | `string` | | Write the image ID to the file |
2828
| `--isolation` | `string` | | Container isolation technology |
2929
| `--label` | `list` | | Set metadata for an image |
3030
| `-m`, `--memory` | `bytes` | `0` | Memory limit |
3131
| `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: -1 to enable unlimited swap |
3232
| `--network` | `string` | `default` | Set the networking mode for the RUN instructions during build |
33-
| `--no-cache` | | | Do not use cache when building the image |
33+
| `--no-cache` | `bool` | | Do not use cache when building the image |
3434
| `--platform` | `string` | | Set platform if server is multi-platform capable |
35-
| `--pull` | | | Always attempt to pull a newer version of the image |
36-
| `-q`, `--quiet` | | | Suppress the build output and print image ID on success |
35+
| `--pull` | `bool` | | Always attempt to pull a newer version of the image |
36+
| `-q`, `--quiet` | `bool` | | Suppress the build output and print image ID on success |
3737
| `--rm` | `bool` | `true` | Remove intermediate containers after a successful build |
3838
| `--security-opt` | `stringSlice` | | Security options |
3939
| `--shm-size` | `bytes` | `0` | Size of `/dev/shm` |
40-
| `--squash` | | | Squash newly built layers into a single new layer |
40+
| `--squash` | `bool` | | Squash newly built layers into a single new layer |
4141
| `-t`, `--tag` | `list` | | Name and optionally a tag in the `name:tag` format |
4242
| `--target` | `string` | | Set the target build stage to build. |
4343
| `--ulimit` | `ulimit` | | Ulimit options |

docs/reference/commandline/builder_build.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,29 +15,29 @@ Build an image from a Dockerfile
1515
| `--build-arg` | `list` | | Set build-time variables |
1616
| `--cache-from` | `stringSlice` | | Images to consider as cache sources |
1717
| `--cgroup-parent` | `string` | | Set the parent cgroup for the `RUN` instructions during build |
18-
| `--compress` | | | Compress the build context using gzip |
18+
| `--compress` | `bool` | | Compress the build context using gzip |
1919
| `--cpu-period` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) period |
2020
| `--cpu-quota` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) quota |
2121
| `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) |
2222
| `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) |
2323
| `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) |
2424
| `--disable-content-trust` | `bool` | `true` | Skip image verification |
2525
| `-f`, `--file` | `string` | | Name of the Dockerfile (Default is `PATH/Dockerfile`) |
26-
| `--force-rm` | | | Always remove intermediate containers |
26+
| `--force-rm` | `bool` | | Always remove intermediate containers |
2727
| `--iidfile` | `string` | | Write the image ID to the file |
2828
| `--isolation` | `string` | | Container isolation technology |
2929
| `--label` | `list` | | Set metadata for an image |
3030
| `-m`, `--memory` | `bytes` | `0` | Memory limit |
3131
| `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: -1 to enable unlimited swap |
3232
| `--network` | `string` | `default` | Set the networking mode for the RUN instructions during build |
33-
| `--no-cache` | | | Do not use cache when building the image |
33+
| `--no-cache` | `bool` | | Do not use cache when building the image |
3434
| `--platform` | `string` | | Set platform if server is multi-platform capable |
35-
| `--pull` | | | Always attempt to pull a newer version of the image |
36-
| `-q`, `--quiet` | | | Suppress the build output and print image ID on success |
35+
| `--pull` | `bool` | | Always attempt to pull a newer version of the image |
36+
| `-q`, `--quiet` | `bool` | | Suppress the build output and print image ID on success |
3737
| `--rm` | `bool` | `true` | Remove intermediate containers after a successful build |
3838
| `--security-opt` | `stringSlice` | | Security options |
3939
| `--shm-size` | `bytes` | `0` | Size of `/dev/shm` |
40-
| `--squash` | | | Squash newly built layers into a single new layer |
40+
| `--squash` | `bool` | | Squash newly built layers into a single new layer |
4141
| `-t`, `--tag` | `list` | | Name and optionally a tag in the `name:tag` format |
4242
| `--target` | `string` | | Set the target build stage to build. |
4343
| `--ulimit` | `ulimit` | | Ulimit options |

docs/reference/commandline/builder_prune.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Remove build cache
77

88
| Name | Type | Default | Description |
99
|:-----------------|:---------|:--------|:------------------------------------------------------|
10-
| `-a`, `--all` | | | Remove all unused build cache, not just dangling ones |
10+
| `-a`, `--all` | `bool` | | Remove all unused build cache, not just dangling ones |
1111
| `--filter` | `filter` | | Provide filter values (e.g. `until=24h`) |
12-
| `-f`, `--force` | | | Do not prompt for confirmation |
12+
| `-f`, `--force` | `bool` | | Do not prompt for confirmation |
1313
| `--keep-storage` | `bytes` | `0` | Amount of disk space to keep for cache |
1414

1515

docs/reference/commandline/checkpoint_create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Create a checkpoint from a running container
88
| Name | Type | Default | Description |
99
|:-------------------|:---------|:--------|:---------------------------------------------|
1010
| `--checkpoint-dir` | `string` | | Use a custom checkpoint storage directory |
11-
| `--leave-running` | | | Leave the container running after checkpoint |
11+
| `--leave-running` | `bool` | | Leave the container running after checkpoint |
1212

1313

1414
<!---MARKER_GEN_END-->

docs/reference/commandline/config_inspect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Display detailed information on one or more configs
88
| Name | Type | Default | Description |
99
|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
1010
| [`-f`](#format), [`--format`](#format) | `string` | | Format output using a custom template:<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
11-
| `--pretty` | | | Print the information in a human friendly format |
11+
| `--pretty` | `bool` | | Print the information in a human friendly format |
1212

1313

1414
<!---MARKER_GEN_END-->

docs/reference/commandline/config_ls.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ List configs
1313
|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
1414
| [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided |
1515
| [`--format`](#format) | `string` | | Format output using a custom template:<br>'table': Print output in table format with column headers (default)<br>'table TEMPLATE': Print output in table format using the given Go template<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
16-
| `-q`, `--quiet` | | | Only display IDs |
16+
| `-q`, `--quiet` | `bool` | | Only display IDs |
1717

1818

1919
<!---MARKER_GEN_END-->

docs/reference/commandline/container_attach.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Attach local standard input, output, and error streams to a running container
1212
| Name | Type | Default | Description |
1313
|:--------------------------------|:---------|:--------|:----------------------------------------------------|
1414
| [`--detach-keys`](#detach-keys) | `string` | | Override the key sequence for detaching a container |
15-
| `--no-stdin` | | | Do not attach STDIN |
15+
| `--no-stdin` | `bool` | | Do not attach STDIN |
1616
| `--sig-proxy` | `bool` | `true` | Proxy all received signals to the process |
1717

1818

docs/reference/commandline/container_cp.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ container source to stdout.
1414

1515
### Options
1616

17-
| Name | Type | Default | Description |
18-
|:----------------------|:-----|:--------|:-------------------------------------------------------------------------------------------------------------|
19-
| `-a`, `--archive` | | | Archive mode (copy all uid/gid information) |
20-
| `-L`, `--follow-link` | | | Always follow symbol link in SRC_PATH |
21-
| `-q`, `--quiet` | | | Suppress progress output during copy. Progress output is automatically suppressed if no terminal is attached |
17+
| Name | Type | Default | Description |
18+
|:----------------------|:-------|:--------|:-------------------------------------------------------------------------------------------------------------|
19+
| `-a`, `--archive` | `bool` | | Archive mode (copy all uid/gid information) |
20+
| `-L`, `--follow-link` | `bool` | | Always follow symbol link in SRC_PATH |
21+
| `-q`, `--quiet` | `bool` | | Suppress progress output during copy. Progress output is automatically suppressed if no terminal is attached |
2222

2323

2424
<!---MARKER_GEN_END-->

0 commit comments

Comments
 (0)