Skip to content

docs: minor grammar fixes #6980

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vvoland merged 3 commits into from
May 14, 2026
Merged

docs: minor grammar fixes #6980

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f550901
docs: minor grammar fixes
thaJeztah May 13, 2026
88e9395
docs, completion: use symlinks instead of symbol(ic) links
thaJeztah May 13, 2026
e4d651d
docs: fix config, secret examples
thaJeztah May 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cli/command/container/cp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ container source to stdout.`,
}

flags := cmd.Flags()
flags.BoolVarP(&opts.followLink, "follow-link", "L", false, "Always follow symbol link in SRC_PATH")
flags.BoolVarP(&opts.followLink, "follow-link", "L", false, "Always follow symlinks in SRC_PATH")
flags.BoolVarP(&opts.copyUIDGID, "archive", "a", false, "Archive mode (copy all uid/gid information)")
flags.BoolVarP(&opts.quiet, "quiet", "q", false, "Suppress progress output during copy. Progress output is automatically suppressed if no terminal is attached")
return cmd
Expand Down Expand Up @@ -271,7 +271,7 @@ func copyFromContainer(ctx context.Context, dockerCLI command.Cli, copyConfig cp
}

apiClient := dockerCLI.Client()
// if client requests to follow symbol link, then must decide target file to be copied
// if client requests to follow symlinks, then must decide target file to be copied
var rebaseName string
if copyConfig.followLink {
src, err := apiClient.ContainerStatPath(ctx, copyConfig.container, client.ContainerStatPathOptions{
Expand Down
2 changes: 1 addition & 1 deletion contrib/completion/fish/docker.fish
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from commit' -a '(__fish_pri
# cp
complete -c docker -f -n '__fish_docker_no_subcommand' -a cp -d "Copy files/folders between a container and the local filesystem"
complete -c docker -A -f -n '__fish_seen_subcommand_from cp' -s a -l archive -d 'Archive mode (copy all uid/gid information)'
complete -c docker -A -f -n '__fish_seen_subcommand_from cp' -s L -l follow-link -d 'Always follow symbol link in SRC_PATH'
complete -c docker -A -f -n '__fish_seen_subcommand_from cp' -s L -l follow-link -d 'Always follow symlinks in SRC_PATH'
complete -c docker -A -f -n '__fish_seen_subcommand_from cp' -l help -d 'Print usage'

# create
Expand Down
2 changes: 1 addition & 1 deletion contrib/completion/zsh/_docker
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -706,7 +706,7 @@ __docker_container_subcommand() {
local state
_arguments $(__docker_arguments) \
$opts_help \
"($help -L --follow-link)"{-L,--follow-link}"[Always follow symbol link]" \
"($help -L --follow-link)"{-L,--follow-link}"[Always follow symlinks]" \
"($help -)1:container:->container" \
"($help -)2:hostpath:_files" && ret=0
case $state in
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/commandline/config_ls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ The following filter matches only services with the `project` label with the
`project-a` value.

```console
$ docker service ls --filter label=project=test
$ docker config ls --filter label=project=project-a

ID NAME CREATED UPDATED
mem02h8n73mybpgqjf0kfi1n0 test_config About an hour ago About an hour ago
Expand All @@ -95,7 +95,7 @@ The `name` filter matches on all or prefix of a config's name.
The following filter matches config with a name containing a prefix of `test`.

```console
$ docker config ls --filter name=test_config
$ docker config ls --filter name=test

ID NAME CREATED UPDATED
mem02h8n73mybpgqjf0kfi1n0 test_config About an hour ago About an hour ago
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commandline/container_cp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ container source to stdout.
| Name | Type | Default | Description |
|:----------------------|:-------|:--------|:-------------------------------------------------------------------------------------------------------------|
| `-a`, `--archive` | `bool` | | Archive mode (copy all uid/gid information) |
| `-L`, `--follow-link` | `bool` | | Always follow symbol link in SRC_PATH |
| `-L`, `--follow-link` | `bool` | | Always follow symlinks in SRC_PATH |
| `-q`, `--quiet` | `bool` | | Suppress progress output during copy. Progress output is automatically suppressed if no terminal is attached |


Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commandline/container_ls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ CONTAINER ID IMAGE COMMAND CREATED
9b6247364a03 busybox "top" 2 minutes ago Up 2 minutes nostalgic_stallman
```

You can also filter for a substring in a name as this shows:
You can filter for a substring in a name as this shows:

```console
$ docker ps --filter "name=nostalgic"
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commandline/cp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ container source to stdout.
| Name | Type | Default | Description |
|:----------------------|:-------|:--------|:-------------------------------------------------------------------------------------------------------------|
| `-a`, `--archive` | `bool` | | Archive mode (copy all uid/gid information) |
| `-L`, `--follow-link` | `bool` | | Always follow symbol link in SRC_PATH |
| `-L`, `--follow-link` | `bool` | | Always follow symlinks in SRC_PATH |
| `-q`, `--quiet` | `bool` | | Suppress progress output during copy. Progress output is automatically suppressed if no terminal is attached |


Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commandline/image_build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ COPY failed: forbidden path outside the build context: ../../some-dir ()
```

BuildKit on the other hand strips leading relative paths that traverse outside
of the build context. Re-using the previous example, the path `COPY
of the build context. Reusing the previous example, the path `COPY
../../some-dir .` evaluates to `COPY some-dir .` with BuildKit.

## Examples
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/commandline/image_pull.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ use `docker pull`.
### Proxy configuration

If you are behind an HTTP proxy server, for example in corporate settings,
before open a connect to registry, you may need to configure the Docker
daemon's proxy settings, refer to the [dockerd command-line reference](https://docs.docker.com/reference/cli/dockerd/#proxy-configuration)
for details.
you may have to configure the Docker daemon to use the proxy server for
operations such as pulling and pushing images. Refer to the
[dockerd command-line reference](https://docs.docker.com/reference/cli/dockerd/#proxy-configuration) for details.

### Concurrent downloads

By default the Docker daemon will pull three layers of an image at a time.
By default the Docker daemon downloads three layers of an image at a time.
If you are on a low bandwidth connection this may cause timeout issues and you may want to lower
this via the `--max-concurrent-downloads` daemon option. See the
[daemon documentation](https://docs.docker.com/reference/cli/dockerd/) for more details.
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/commandline/secret_ls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ The following filter matches only services with the `project` label with the
`project-a` value.

```console
$ docker service ls --filter label=project=test
$ docker secret ls --filter label=project=project-a

ID NAME CREATED UPDATED
mem02h8n73mybpgqjf0kfi1n0 test_secret About an hour ago About an hour ago
Expand All @@ -95,7 +95,7 @@ The `name` filter matches on all or prefix of a secret's name.
The following filter matches secret with a name containing a prefix of `test`.

```console
$ docker secret ls --filter name=test_secret
$ docker secret ls --filter name=test

ID NAME CREATED UPDATED
mem02h8n73mybpgqjf0kfi1n0 test_secret About an hour ago About an hour ago
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commandline/swarm_ca.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ desired root digest: sha256:05da740cf2577a25224c53019e2cce99bcc5ba09664ad6bb2a94
rotated CA certificates: [> ] 0/2 nodes
```

Once the rotation os finished (all the progress bars have completed) the now-current
Once the rotation is finished (all the progress bars have completed) the now-current
CA certificate will be printed:

```console
Expand Down
2 changes: 1 addition & 1 deletion man/docker-run.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -734,7 +734,7 @@ any options, the systems uses the following options:
**-u**, **--user**=""
Sets the username or UID used and optionally the groupname or GID for the specified command.

The followings examples are all valid:
The following examples are all valid:
--user [user | user:group | uid | uid:gid | user:gid | uid:group ]

Without this argument the command will be run as root in the container.
Expand Down
2 changes: 1 addition & 1 deletion man/src/container/exec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ the same capabilities as the container, which may be limited. Set
# USER
`user` sets the username or UID used and optionally the groupname or GID for the specified command.

The followings examples are all valid:
The following examples are all valid:
--user [user | user:group | uid | uid:gid | user:gid | uid:group ]

Without this argument the command will be run as root in the container.
Expand Down
2 changes: 1 addition & 1 deletion man/src/volume.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The `docker volume` command has subcommands for managing data volumes. A data
volume is a specially-designated directory that by-passes storage driver
volume is a specially-designated directory that bypasses storage driver
management.

Data volumes persist data independent of a container's life cycle. When you
Expand Down