Skip to content

[28.x backport] docs fixes and fix flag annotation #6380

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
austinvazquez merged 3 commits into from
Aug 27, 2025
Merged

[28.x backport] docs fixes and fix flag annotation #6380

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
f385cb9
docs: fix sentence structures in 'run.md'
hsnabszhdn Aug 23, 2025
c712d97
docs: add missing backticks in 'run.md'
hsnabszhdn Aug 23, 2025
3b68cde
cli/command/service: fix API annotations for generic resource flags
thaJeztah Aug 25, 2025
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/service/update.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,9 @@ func newUpdateCommand(dockerCLI command.Cli) *cobra.Command {

// Add needs parsing, Remove only needs the key
flags.Var(newListOptsVar(), flagGenericResourcesRemove, "Remove a Generic resource")
flags.SetAnnotation(flagHostAdd, "version", []string{"1.32"})
flags.SetAnnotation(flagGenericResourcesRemove, "version", []string{"1.32"})
flags.Var(newListOptsVarWithValidator(ValidateSingleGenericResource), flagGenericResourcesAdd, "Add a Generic resource")
flags.SetAnnotation(flagHostAdd, "version", []string{"1.32"})
flags.SetAnnotation(flagGenericResourcesAdd, "version", []string{"1.32"})

// TODO(thaJeztah): add completion for capabilities, stop-signal (currently non-exported in container package)
// _ = cmd.RegisterFlagCompletionFunc(flagCapAdd, completeLinuxCapabilityNames)
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ $ docker run -it --mount type=bind,source=[PATH],target=[PATH] busybox
```

In this case, the `--mount` flag takes three parameters. A type (`bind`), and
two paths. The `source` path is a the location on the host that you want to
two paths. The `source` path is the location on the host that you want to
bind mount into the container. The `target` path is the mount destination
inside the container.

Expand Down Expand Up @@ -419,7 +419,7 @@ $ docker run -it -m 300M ubuntu:24.04 /bin/bash

We set memory limit only, this means the processes in the container can use
300M memory and 300M swap memory, by default, the total virtual memory size
(--memory-swap) will be set as double of memory, in this case, memory + swap
(`--memory-swap`) will be set as double of memory, in this case, memory + swap
would be 2*300M, so processes can use 300M swap memory as well.

```console
Expand Down Expand Up @@ -1087,7 +1087,7 @@ Additionally, you can set any environment variable in the container by using
one or more `-e` flags. You can even override the variables mentioned above, or
variables defined using a Dockerfile `ENV` instruction when building the image.

If the you name an environment variable without specifying a value, the current
If you name an environment variable without specifying a value, the current
value of the named variable on the host is propagated into the container's
environment:

Expand Down
Loading