From e050312e6dde9277bb29d102ea9fd8e4f87f6f60 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Wed, 23 Aug 2023 11:39:32 +0200 Subject: [PATCH] update flag-description for --cgroup-parent This attempts to make it clearer that the --cgroup-parent option is only used for the containers used during build. Instead of mentioning "build container", I opted for using "RUN instructions" (to match the --network description), although this may not be ideal (as it assumes the "Dockerfile" front-end, which of course may not be the case). Signed-off-by: Sebastiaan van Stijn --- cli/command/image/build.go | 2 +- docs/reference/commandline/build.md | 2 +- docs/reference/commandline/builder_build.md | 2 +- docs/reference/commandline/image_build.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/cli/command/image/build.go b/cli/command/image/build.go index dd7510c440..0844fd766f 100644 --- a/cli/command/image/build.go +++ b/cli/command/image/build.go @@ -126,7 +126,7 @@ func NewBuildCommand(dockerCli command.Cli) *cobra.Command { flags.Int64Var(&options.cpuQuota, "cpu-quota", 0, "Limit the CPU CFS (Completely Fair Scheduler) quota") flags.StringVar(&options.cpuSetCpus, "cpuset-cpus", "", "CPUs in which to allow execution (0-3, 0,1)") flags.StringVar(&options.cpuSetMems, "cpuset-mems", "", "MEMs in which to allow execution (0-3, 0,1)") - flags.StringVar(&options.cgroupParent, "cgroup-parent", "", "Optional parent cgroup for the container") + flags.StringVar(&options.cgroupParent, "cgroup-parent", "", `Set the parent cgroup for the "RUN" instructions during build`) flags.StringVar(&options.isolation, "isolation", "", "Container isolation technology") flags.Var(&options.labels, "label", "Set metadata for an image") flags.BoolVar(&options.noCache, "no-cache", false, "Do not use cache when building the image") diff --git a/docs/reference/commandline/build.md b/docs/reference/commandline/build.md index c3435f57c5..2f8be4f7f9 100644 --- a/docs/reference/commandline/build.md +++ b/docs/reference/commandline/build.md @@ -14,7 +14,7 @@ Build an image from a Dockerfile | [`--add-host`](#add-host) | `list` | | Add a custom host-to-IP mapping (`host:ip`) | | [`--build-arg`](#build-arg) | `list` | | Set build-time variables | | [`--cache-from`](#cache-from) | `stringSlice` | | Images to consider as cache sources | -| [`--cgroup-parent`](#cgroup-parent) | `string` | | Optional parent cgroup for the container | +| [`--cgroup-parent`](#cgroup-parent) | `string` | | Set the parent cgroup for the `RUN` instructions during build | | `--compress` | | | Compress the build context using gzip | | `--cpu-period` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) period | | `--cpu-quota` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) quota | diff --git a/docs/reference/commandline/builder_build.md b/docs/reference/commandline/builder_build.md index 0272728b98..5614210306 100644 --- a/docs/reference/commandline/builder_build.md +++ b/docs/reference/commandline/builder_build.md @@ -14,7 +14,7 @@ Build an image from a Dockerfile | `--add-host` | `list` | | Add a custom host-to-IP mapping (`host:ip`) | | `--build-arg` | `list` | | Set build-time variables | | `--cache-from` | `stringSlice` | | Images to consider as cache sources | -| `--cgroup-parent` | `string` | | Optional parent cgroup for the container | +| `--cgroup-parent` | `string` | | Set the parent cgroup for the `RUN` instructions during build | | `--compress` | | | Compress the build context using gzip | | `--cpu-period` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) period | | `--cpu-quota` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) quota | diff --git a/docs/reference/commandline/image_build.md b/docs/reference/commandline/image_build.md index b60e61312a..e27c85964e 100644 --- a/docs/reference/commandline/image_build.md +++ b/docs/reference/commandline/image_build.md @@ -14,7 +14,7 @@ Build an image from a Dockerfile | `--add-host` | `list` | | Add a custom host-to-IP mapping (`host:ip`) | | `--build-arg` | `list` | | Set build-time variables | | `--cache-from` | `stringSlice` | | Images to consider as cache sources | -| `--cgroup-parent` | `string` | | Optional parent cgroup for the container | +| `--cgroup-parent` | `string` | | Set the parent cgroup for the `RUN` instructions during build | | `--compress` | | | Compress the build context using gzip | | `--cpu-period` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) period | | `--cpu-quota` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) quota |