From 3c4fe7b3e608232c51c781e6331f6ad1cdcb96bb Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Wed, 19 Jul 2023 15:03:40 +0200 Subject: [PATCH 1/8] docs: add missing docs for "DOCKER_TLS" env-var Signed-off-by: Sebastiaan van Stijn (cherry picked from commit b52fd79f1ddc50e85568d81c56056209dd2e43f4) Signed-off-by: Sebastiaan van Stijn --- docs/reference/commandline/cli.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/reference/commandline/cli.md b/docs/reference/commandline/cli.md index 93df51ea4dbb..92f4f390741f 100644 --- a/docs/reference/commandline/cli.md +++ b/docs/reference/commandline/cli.md @@ -134,6 +134,7 @@ line: | `DOCKER_DEFAULT_PLATFORM` | Default platform for commands that take the `--platform` flag. | | `DOCKER_HIDE_LEGACY_COMMANDS` | When set, Docker hides "legacy" top-level commands (such as `docker rm`, and `docker pull`) in `docker help` output, and only `Management commands` per object-type (e.g., `docker container`) are printed. This may become the default in a future release. | | `DOCKER_HOST` | Daemon socket to connect to. | +| `DOCKER_TLS` | Enable TLS for connections made by the `docker` CLI (equivalent of the `--tls` command-line option). Set to a non-empty value to enable TLS. Note that TLS is enabled automatically if any of the other TLS options are set. | | `DOCKER_TLS_VERIFY` | When set Docker uses TLS and verifies the remote. This variable is used both by the `docker` CLI and the [`dockerd` daemon](dockerd.md) | | `BUILDKIT_PROGRESS` | Set type of progress output (`auto`, `plain`, `tty`) when [building](build.md) with [BuildKit backend](https://docs.docker.com/build/buildkit/). Use plain to show container output (default `auto`). | From 08ad72160ff01c81d605821051294be6cb710ac5 Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Sat, 12 Aug 2023 14:19:17 +0100 Subject: [PATCH 2/8] Update docs/command output for volume pruning In previous versions of the Docker API, `system prune --volumes` and `volume prune` would remove all dangling volumes. With API v1.42, this was changed so that only anonymous volumes would be removed unless the all filter was specified. Some of the docs were updated in #4218, however, there were a couple of places left that didn't make the anonymous vs named volumes distinction clear. This replaces #4079, which was bitrotted by #4218. See also #4028. Closes #4079. Signed-off-by: Ed Morley <501702+edmorley@users.noreply.github.com> (cherry picked from commit 6e2e92d774eccdd7f5cf3e08210ca34a1a75643b) Signed-off-by: Sebastiaan van Stijn --- cli/command/system/prune.go | 4 ++-- cli/command/volume/prune.go | 2 +- docs/reference/commandline/index.md | 2 +- docs/reference/commandline/system_prune.md | 6 +++--- docs/reference/commandline/volume.md | 2 +- docs/reference/commandline/volume_prune.md | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/cli/command/system/prune.go b/cli/command/system/prune.go index 51773cce3a38..9a4e88fd7783 100644 --- a/cli/command/system/prune.go +++ b/cli/command/system/prune.go @@ -48,7 +48,7 @@ func newPruneCommand(dockerCli command.Cli) *cobra.Command { flags := cmd.Flags() flags.BoolVarP(&options.force, "force", "f", false, "Do not prompt for confirmation") flags.BoolVarP(&options.all, "all", "a", false, "Remove all unused images not just dangling ones") - flags.BoolVar(&options.pruneVolumes, "volumes", false, "Prune volumes") + flags.BoolVar(&options.pruneVolumes, "volumes", false, "Prune anonymous volumes") flags.Var(&options.filter, "filter", `Provide filter values (e.g. "label==")`) // "filter" flag is available in 1.28 (docker 17.04) and up flags.SetAnnotation("filter", "version", []string{"1.28"}) @@ -114,7 +114,7 @@ func confirmationMessage(dockerCli command.Cli, options pruneOptions) string { "all networks not used by at least one container", } if options.pruneVolumes { - warnings = append(warnings, "all volumes not used by at least one container") + warnings = append(warnings, "all anonymous volumes not used by at least one container") } if options.all { warnings = append(warnings, "all images without at least one container associated to them") diff --git a/cli/command/volume/prune.go b/cli/command/volume/prune.go index a85cb3883369..d4ed935da993 100644 --- a/cli/command/volume/prune.go +++ b/cli/command/volume/prune.go @@ -27,7 +27,7 @@ func NewPruneCommand(dockerCli command.Cli) *cobra.Command { cmd := &cobra.Command{ Use: "prune [OPTIONS]", - Short: "Remove all unused local volumes", + Short: "Remove unused local volumes", Args: cli.NoArgs, RunE: func(cmd *cobra.Command, args []string) error { spaceReclaimed, output, err := runPrune(dockerCli, options) diff --git a/docs/reference/commandline/index.md b/docs/reference/commandline/index.md index 0dc074d67676..2dd4e7e4d0fd 100644 --- a/docs/reference/commandline/index.md +++ b/docs/reference/commandline/index.md @@ -101,7 +101,7 @@ read the [`dockerd`](dockerd.md) reference page. | [volume create](volume_create.md) | Creates a new volume where containers can consume and store data | | [volume inspect](volume_inspect.md) | Display information about a volume | | [volume ls](volume_ls.md) | Lists all the volumes Docker knows about | -| [volume prune](volume_prune.md) | Remove all unused local volumes | +| [volume prune](volume_prune.md) | Remove unused local volumes | | [volume rm](volume_rm.md) | Remove one or more volumes | ### Swarm node commands diff --git a/docs/reference/commandline/system_prune.md b/docs/reference/commandline/system_prune.md index 72b7d80f9f8b..728cb87fcec8 100644 --- a/docs/reference/commandline/system_prune.md +++ b/docs/reference/commandline/system_prune.md @@ -10,7 +10,7 @@ Remove unused data | `-a`, `--all` | | | Remove all unused images not just dangling ones | | [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `label==`) | | `-f`, `--force` | | | Do not prompt for confirmation | -| `--volumes` | | | Prune volumes | +| `--volumes` | | | Prune anonymous volumes | @@ -50,7 +50,7 @@ Total reclaimed space: 1.84kB By default, volumes are not removed to prevent important data from being deleted if there is currently no container using the volume. Use the `--volumes` -flag when running the command to prune volumes as well: +flag when running the command to prune anonymous volumes as well: ```console $ docker system prune -a --volumes @@ -58,7 +58,7 @@ $ docker system prune -a --volumes WARNING! This will remove: - all stopped containers - all networks not used by at least one container - - all volumes not used by at least one container + - all anonymous volumes not used by at least one container - all images without at least one container associated to them - all build cache Are you sure you want to continue? [y/N] y diff --git a/docs/reference/commandline/volume.md b/docs/reference/commandline/volume.md index 8f30002523e9..9f2d7888e77a 100644 --- a/docs/reference/commandline/volume.md +++ b/docs/reference/commandline/volume.md @@ -10,7 +10,7 @@ Manage volumes | [`create`](volume_create.md) | Create a volume | | [`inspect`](volume_inspect.md) | Display detailed information on one or more volumes | | [`ls`](volume_ls.md) | List volumes | -| [`prune`](volume_prune.md) | Remove all unused local volumes | +| [`prune`](volume_prune.md) | Remove unused local volumes | | [`rm`](volume_rm.md) | Remove one or more volumes | | [`update`](volume_update.md) | Update a volume (cluster volumes only) | diff --git a/docs/reference/commandline/volume_prune.md b/docs/reference/commandline/volume_prune.md index 4230c6efe342..9c923df32534 100644 --- a/docs/reference/commandline/volume_prune.md +++ b/docs/reference/commandline/volume_prune.md @@ -1,7 +1,7 @@ # volume prune -Remove all unused local volumes +Remove unused local volumes ### Options From daeee469773f7655af52301c023e68b3f3fcd70e Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Wed, 23 Aug 2023 11:39:32 +0200 Subject: [PATCH 3/8] 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 (cherry picked from commit e050312e6dde9277bb29d102ea9fd8e4f87f6f60) 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 27b6cafd876b..2c69a23b9647 100644 --- a/cli/command/image/build.go +++ b/cli/command/image/build.go @@ -128,7 +128,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 c3435f57c547..2f8be4f7f97e 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 0272728b98e3..56142103060c 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 b60e61312af8..e27c85964ec3 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 | From cfbaee4689a4c7cb6b7480576bca8dca4957dd22 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Fri, 25 Aug 2023 14:09:07 +0200 Subject: [PATCH 4/8] CONTRIBUTING.md: update links - docs moved to https://go.dev/doc/ - blog moved to https://go.dev/blog/ - update DCO link to use https Signed-off-by: Sebastiaan van Stijn (cherry picked from commit 1d3af726eb73ea1593672b008e98465b03efb406) Signed-off-by: Sebastiaan van Stijn --- CONTRIBUTING.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9feba24c8869..127364fdf364 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -192,7 +192,7 @@ For more details, see the [MAINTAINERS](MAINTAINERS) page. The sign-off is a simple line at the end of the explanation for the patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify -the below (from [developercertificate.org](http://developercertificate.org/)): +the below (from [developercertificate.org](https://developercertificate.org): ``` Developer Certificate of Origin @@ -336,9 +336,8 @@ The rules: 1. All code should be formatted with `gofumpt` (preferred) or `gofmt -s`. 2. All code should pass the default levels of [`golint`](https://github.com/golang/lint). -3. All code should follow the guidelines covered in [Effective - Go](http://golang.org/doc/effective_go.html) and [Go Code Review - Comments](https://github.com/golang/go/wiki/CodeReviewComments). +3. All code should follow the guidelines covered in [Effective Go](https://go.dev/doc/effective_go) + and [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments). 4. Comment the code. Tell us the why, the history and the context. 5. Document _all_ declarations and methods, even private ones. Declare expectations, caveats and anything else that may be important. If a type @@ -360,6 +359,6 @@ The rules: guidelines. Since you've read all the rules, you now know that. If you are having trouble getting into the mood of idiomatic Go, we recommend -reading through [Effective Go](https://golang.org/doc/effective_go.html). The -[Go Blog](https://blog.golang.org) is also a great resource. Drinking the +reading through [Effective Go](https://go.dev/doc/effective_go). The +[Go Blog](https://go.dev/blog/) is also a great resource. Drinking the kool-aid is a lot easier than going thirsty. From e9f843bf04268b8bb2c508aefda7cd8651888b23 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Fri, 25 Aug 2023 14:10:40 +0200 Subject: [PATCH 5/8] docs/reference: update links to Go documentation Go documentation moved to the `go.dev` domain; curl -sI https://golang.org/doc/install/source#environment | grep 'location' location: https://go.dev/doc/install/source Signed-off-by: Sebastiaan van Stijn (cherry picked from commit dc4feccb89c69e5bb6afd32c3e4be8047ecf8fd0) Signed-off-by: Sebastiaan van Stijn --- docs/reference/commandline/config_inspect.md | 2 +- docs/reference/commandline/events.md | 2 +- docs/reference/commandline/info.md | 2 +- docs/reference/commandline/inspect.md | 2 +- docs/reference/commandline/logs.md | 2 +- docs/reference/commandline/network_inspect.md | 2 +- docs/reference/commandline/node_inspect.md | 2 +- docs/reference/commandline/secret_inspect.md | 2 +- docs/reference/commandline/service_create.md | 2 +- docs/reference/commandline/service_inspect.md | 2 +- docs/reference/commandline/service_logs.md | 2 +- docs/reference/commandline/system_events.md | 2 +- docs/reference/commandline/volume_inspect.md | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/reference/commandline/config_inspect.md b/docs/reference/commandline/config_inspect.md index e112a3c95d6d..7f5a9f6ba5c4 100644 --- a/docs/reference/commandline/config_inspect.md +++ b/docs/reference/commandline/config_inspect.md @@ -20,7 +20,7 @@ Inspects the specified config. By default, this renders all results in a JSON array. If a format is specified, the given template will be executed for each result. -Go's [text/template](https://golang.org/pkg/text/template/) package +Go's [text/template](https://pkg.go.dev/text/template) package describes all the details of the format. For detailed information about using configs, refer to [store configuration data using Docker Configs](https://docs.docker.com/engine/swarm/configs/). diff --git a/docs/reference/commandline/events.md b/docs/reference/commandline/events.md index 906fd5b71a7c..44baef0449bb 100644 --- a/docs/reference/commandline/events.md +++ b/docs/reference/commandline/events.md @@ -194,7 +194,7 @@ The currently supported filters are: If a format (`--format`) is specified, the given template will be executed instead of the default -format. Go's [text/template](https://golang.org/pkg/text/template/) package +format. Go's [text/template](https://pkg.go.dev/text/template) package describes all the details of the format. If a format is set to `{{json .}}`, the events are streamed as valid JSON diff --git a/docs/reference/commandline/info.md b/docs/reference/commandline/info.md index 56be0fd2ef93..4b62581ac54a 100644 --- a/docs/reference/commandline/info.md +++ b/docs/reference/commandline/info.md @@ -24,7 +24,7 @@ The number of images shown is the number of unique images. The same image tagged under different names is counted only once. If a format is specified, the given template will be executed instead of the -default format. Go's [text/template](https://golang.org/pkg/text/template/) package +default format. Go's [text/template](https://pkg.go.dev/text/template) package describes all the details of the format. Depending on the storage driver in use, additional information can be shown, such diff --git a/docs/reference/commandline/inspect.md b/docs/reference/commandline/inspect.md index 9174dc077dee..eb2196860f21 100644 --- a/docs/reference/commandline/inspect.md +++ b/docs/reference/commandline/inspect.md @@ -24,7 +24,7 @@ By default, `docker inspect` will render results in a JSON array. If a format is specified, the given template will be executed for each result. -Go's [text/template](https://golang.org/pkg/text/template/) package describes +Go's [text/template](https://pkg.go.dev/text/template) package describes all the details of the format. ### Specify target type (--type) diff --git a/docs/reference/commandline/logs.md b/docs/reference/commandline/logs.md index 2c98415ae24c..5fddcbdf0c69 100644 --- a/docs/reference/commandline/logs.md +++ b/docs/reference/commandline/logs.md @@ -34,7 +34,7 @@ the container's `STDOUT` and `STDERR`. Passing a negative number or a non-integer to `--tail` is invalid and the value is set to `all` in that case. -The `docker logs --timestamps` command will add an [RFC3339Nano timestamp](https://golang.org/pkg/time/#pkg-constants) +The `docker logs --timestamps` command will add an [RFC3339Nano timestamp](https://pkg.go.dev/time#RFC3339Nano) , for example `2014-09-16T06:17:46.000000000Z`, to each log entry. To ensure that the timestamps are aligned the nano-second part of the timestamp will be padded with zero when necessary. diff --git a/docs/reference/commandline/network_inspect.md b/docs/reference/commandline/network_inspect.md index d0129d0fe128..5025d964d967 100644 --- a/docs/reference/commandline/network_inspect.md +++ b/docs/reference/commandline/network_inspect.md @@ -41,7 +41,7 @@ node are shown. You can specify an alternate format to execute a given template for each result. Go's -[text/template](https://golang.org/pkg/text/template/) package describes all the +[text/template](https://pkg.go.dev/text/template) package describes all the details of the format. ```console diff --git a/docs/reference/commandline/node_inspect.md b/docs/reference/commandline/node_inspect.md index 056a1c8c365e..cc99d4f74084 100644 --- a/docs/reference/commandline/node_inspect.md +++ b/docs/reference/commandline/node_inspect.md @@ -18,7 +18,7 @@ Display detailed information on one or more nodes Returns information about a node. By default, this command renders all results in a JSON array. You can specify an alternate format to execute a given template for each result. Go's -[text/template](https://golang.org/pkg/text/template/) package describes all the +[text/template](https://pkg.go.dev/text/template) package describes all the details of the format. > **Note** diff --git a/docs/reference/commandline/secret_inspect.md b/docs/reference/commandline/secret_inspect.md index 1540d5bb35d9..76fd1e713f68 100644 --- a/docs/reference/commandline/secret_inspect.md +++ b/docs/reference/commandline/secret_inspect.md @@ -20,7 +20,7 @@ Inspects the specified secret. By default, this renders all results in a JSON array. If a format is specified, the given template will be executed for each result. -Go's [text/template](https://golang.org/pkg/text/template/) package +Go's [text/template](https://pkg.go.dev/text/template) package describes all the details of the format. For detailed information about using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/). diff --git a/docs/reference/commandline/service_create.md b/docs/reference/commandline/service_create.md index 1f0af431e761..b89c00beea46 100644 --- a/docs/reference/commandline/service_create.md +++ b/docs/reference/commandline/service_create.md @@ -1013,7 +1013,7 @@ registry value must be located in: ### Create services using templates You can use templates for some flags of `service create`, using the syntax -provided by the Go's [text/template](https://golang.org/pkg/text/template/) package. +provided by the Go's [text/template](https://pkg.go.dev/text/template) package. The supported flags are the following : diff --git a/docs/reference/commandline/service_inspect.md b/docs/reference/commandline/service_inspect.md index 583b02fe55b3..9bfd6f0afdab 100644 --- a/docs/reference/commandline/service_inspect.md +++ b/docs/reference/commandline/service_inspect.md @@ -20,7 +20,7 @@ Inspects the specified service. By default, this renders all results in a JSON array. If a format is specified, the given template will be executed for each result. -Go's [text/template](https://golang.org/pkg/text/template/) package +Go's [text/template](https://pkg.go.dev/text/template) package describes all the details of the format. > **Note** diff --git a/docs/reference/commandline/service_logs.md b/docs/reference/commandline/service_logs.md index b5808f591d03..8ebab359f9c6 100644 --- a/docs/reference/commandline/service_logs.md +++ b/docs/reference/commandline/service_logs.md @@ -50,7 +50,7 @@ the service's `STDOUT` and `STDERR`. Passing a negative number or a non-integer to `--tail` is invalid and the value is set to `all` in that case. -The `docker service logs --timestamps` command will add an [RFC3339Nano timestamp](https://golang.org/pkg/time/#pkg-constants) +The `docker service logs --timestamps` command will add an [RFC3339Nano timestamp](https://pkg.go.dev/time#RFC3339Nano) , for example `2014-09-16T06:17:46.000000000Z`, to each log entry. To ensure that the timestamps are aligned the nano-second part of the timestamp will be padded with zero when necessary. diff --git a/docs/reference/commandline/system_events.md b/docs/reference/commandline/system_events.md index 35788bcc3993..e580f4b9c810 100644 --- a/docs/reference/commandline/system_events.md +++ b/docs/reference/commandline/system_events.md @@ -308,7 +308,7 @@ $ docker system events --filter 'type=plugin' ### Format the output (--format) If a format (`--format`) is specified, the given template will be executed -instead of the default format. Go's [text/template](https://golang.org/pkg/text/template/) +instead of the default format. Go's [text/template](https://pkg.go.dev/text/template) package describes all the details of the format. ```console diff --git a/docs/reference/commandline/volume_inspect.md b/docs/reference/commandline/volume_inspect.md index cfe36e85712e..cd4a75a4253a 100644 --- a/docs/reference/commandline/volume_inspect.md +++ b/docs/reference/commandline/volume_inspect.md @@ -17,7 +17,7 @@ Display detailed information on one or more volumes Returns information about a volume. By default, this command renders all results in a JSON array. You can specify an alternate format to execute a given template for each result. Go's -[text/template](https://golang.org/pkg/text/template/) package describes all the +[text/template](https://pkg.go.dev/text/template) package describes all the details of the format. ## Examples From d9775310184990f5c8bbcc544a0882235e3e24cc Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Fri, 25 Aug 2023 14:11:18 +0200 Subject: [PATCH 6/8] man: update links to Go documentation Go documentation moved to the `go.dev` domain; curl -sI https://golang.org/doc/install/source#environment | grep 'location' location: https://go.dev/doc/install/source Also updated some links to use https, where available. Signed-off-by: Sebastiaan van Stijn (cherry picked from commit 722e3aae4f9ff5ba5cba4764a825288e6e0618ea) Signed-off-by: Sebastiaan van Stijn --- man/src/container/exec.md | 2 +- man/src/inspect.md | 2 +- man/src/network/inspect.md | 2 +- man/src/system/events.md | 2 +- man/src/volume/inspect.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/man/src/container/exec.md b/man/src/container/exec.md index c597817eeaeb..82d1428d45f7 100644 --- a/man/src/container/exec.md +++ b/man/src/container/exec.md @@ -9,7 +9,7 @@ container is unpaused, and then run # CAPABILITIES `privileged` gives the process extended -[Linux capabilities](http://man7.org/linux/man-pages/man7/capabilities.7.html) +[Linux capabilities](https://man7.org/linux/man-pages/man7/capabilities.7.html) when running in a container. Without this flag, the process run by `docker exec` in a running container has diff --git a/man/src/inspect.md b/man/src/inspect.md index b2d048d0fc55..d92dde73aa72 100644 --- a/man/src/inspect.md +++ b/man/src/inspect.md @@ -193,7 +193,7 @@ output: 80/tcp -> 80 You can get more information about how to write a Go template from: -https://golang.org/pkg/text/template/. +https://pkg.go.dev/text/template. ## Getting size information on a container diff --git a/man/src/network/inspect.md b/man/src/network/inspect.md index f00489d506b1..e07c8ab1fc9f 100644 --- a/man/src/network/inspect.md +++ b/man/src/network/inspect.md @@ -11,7 +11,7 @@ bda12f8922785d1f160be70736f26c1e331ab8aaf8ed8d56728508f2e2fd4727 The `network inspect` command shows the containers, by id, in its results. You can specify an alternate format to execute a given template for each result. Go's -[text/template](http://golang.org/pkg/text/template/) package +[text/template](https://pkg.go.dev/text/template) package describes all the details of the format. ```console diff --git a/man/src/system/events.md b/man/src/system/events.md index 8177293f532a..d18e175c6f99 100644 --- a/man/src/system/events.md +++ b/man/src/system/events.md @@ -85,7 +85,7 @@ details of the format. Type=container Status=destroy ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 If a format is set to `{{json .}}`, the events are streamed as valid JSON -Lines. For information about JSON Lines, please refer to http://jsonlines.org/ . +Lines. For information about JSON Lines, please refer to https://jsonlines.org . # docker events --format '{{json .}}' {"status":"create","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4.. diff --git a/man/src/volume/inspect.md b/man/src/volume/inspect.md index 0885caab634d..cb58406b075a 100644 --- a/man/src/volume/inspect.md +++ b/man/src/volume/inspect.md @@ -1,4 +1,4 @@ Returns information about one or more volumes. By default, this command renders all results in a JSON array. You can specify an alternate format to execute a -given template is executed for each result. Go's https://golang.org/pkg/text/template/ +given template is executed for each result. Go's https://pkg.go.dev/text/template package describes all the details of the format. From 6efe73abe07b88d5979f2d20070cc564f8beecb4 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Fri, 25 Aug 2023 14:12:45 +0200 Subject: [PATCH 7/8] cli/command/manifest: update link to Go documentation Signed-off-by: Sebastiaan van Stijn (cherry picked from commit 273f2cd95e3dfce6c35c34698cab6ddc4ea25217) Signed-off-by: Sebastiaan van Stijn --- cli/command/manifest/util.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cli/command/manifest/util.go b/cli/command/manifest/util.go index 16aba15c7488..f25ff0ad99a3 100644 --- a/cli/command/manifest/util.go +++ b/cli/command/manifest/util.go @@ -16,7 +16,7 @@ type osArch struct { // Remove any unsupported os/arch combo // list of valid os/arch values (see "Optional Environment Variables" section -// of https://golang.org/doc/install/source +// of https://go.dev/doc/install/source // Added linux/s390x as we know System z support already exists // Keep in sync with _docker_manifest_annotate in contrib/completion/bash/docker var validOSArches = map[osArch]bool{ From d9770a962e23b159d77be6e8be0bb6a87e8d6668 Mon Sep 17 00:00:00 2001 From: Vaclav Struhar Date: Fri, 25 Aug 2023 15:06:16 +0200 Subject: [PATCH 8/8] adding -c option for docker run/build in manpages Signed-off-by: Vaclav Struhar (cherry picked from commit be219b3172e2d16368d64dbabcb5662413b9f6b5) Signed-off-by: Sebastiaan van Stijn --- man/docker-build.1.md | 6 +++--- man/docker-run.1.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/man/docker-build.1.md b/man/docker-build.1.md index 0ac30bcc2fbc..341a3db3a122 100644 --- a/man/docker-build.1.md +++ b/man/docker-build.1.md @@ -8,7 +8,7 @@ docker-build - Build an image from a Dockerfile [**--add-host**[=*[]*]] [**--build-arg**[=*[]*]] [**--cache-from**[=*[]*]] -[**--cpu-shares**[=*0*]] +[**-c**|**--cpu-shares**[=*0*]] [**--cgroup-parent**[=*CGROUP-PARENT*]] [**--help**] [**--iidfile**[=*CIDFILE*]] @@ -153,7 +153,7 @@ In Linux, default is **bridge**. Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g` (gigabytes). If you omit the unit, the system uses bytes. If you omit the size entirely, the system uses `64m`. -**--cpu-shares** *0* +**-c**, **--cpu-shares** *0* CPU shares (relative weight). By default, all containers get the same proportion of CPU cycles. @@ -166,7 +166,7 @@ In Linux, default is **bridge**. You can change this proportion by adjusting the container's CPU share weighting relative to the weighting of all other running containers. - To modify the proportion from the default of 1024, use the **--cpu-shares** + To modify the proportion from the default of 1024, use the **-c** or **--cpu-shares** flag to set the weighting to 2 or higher. Container CPU share Flag diff --git a/man/docker-run.1.md b/man/docker-run.1.md index 13d42984f02a..13da2c76c465 100644 --- a/man/docker-run.1.md +++ b/man/docker-run.1.md @@ -10,7 +10,7 @@ docker-run - Create and run a new container from an image [**--annotation**[=*[]*]] [**--blkio-weight**[=*[BLKIO-WEIGHT]*]] [**--blkio-weight-device**[=*[]*]] -[**--cpu-shares**[=*0*]] +[**-c**|**--cpu-shares**[=*0*]] [**--cap-add**[=*[]*]] [**--cap-drop**[=*[]*]] [**--cgroupns**[=*[]*]] @@ -137,14 +137,14 @@ option can be set multiple times. **--blkio-weight-device**=[] Block IO weight (relative device weight, format: `DEVICE_NAME:WEIGHT`). -**--cpu-shares**=*0* +**-c**, **--cpu-shares**=*0* CPU shares (relative weight) By default, all containers get the same proportion of CPU cycles. This proportion can be modified by changing the container's CPU share weighting relative to the weighting of all other running containers. -To modify the proportion from the default of 1024, use the **--cpu-shares** +To modify the proportion from the default of 1024, use the **-c** or **--cpu-shares** flag to set the weighting to 2 or higher. The proportion will only apply when CPU-intensive processes are running.