Skip to content

Commit ae456a8

Browse files
committed
docs: minor editorial improvements, typo fixes
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
1 parent 9b06602 commit ae456a8

28 files changed

+376
-399
lines changed

docs/reference/commandline/attach.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ Use `docker attach` to attach your terminal's standard input, output, and error
2525
ID or name. This allows you to view its ongoing output or to control it
2626
interactively, as though the commands were running directly in your terminal.
2727

28-
> **Note:**
29-
> The `attach` command will display the output of the `ENTRYPOINT/CMD` process. This
28+
> **Note**
29+
>
30+
> The `attach` command will display the output of the `ENTRYPOINT/CMD` process. This
3031
> can appear as if the attach command is hung when in fact the process may simply
3132
> not be interacting with the terminal at that time.
3233
@@ -38,11 +39,11 @@ container. If `--sig-proxy` is true (the default),`CTRL-c` sends a `SIGINT` to
3839
the container. If the container was run with `-i` and `-t`, you can detach from
3940
a container and leave it running using the `CTRL-p CTRL-q` key sequence.
4041

41-
> **Note:**
42+
> **Note**
43+
>
4244
> A process running as PID 1 inside a container is treated specially by
4345
> Linux: it ignores any signal with the default action. So, the process
44-
> will not terminate on `SIGINT` or `SIGTERM` unless it is coded to do
45-
> so.
46+
> won't terminate on `SIGINT` or `SIGTERM` unless it's coded to do so.
4647
4748
It is forbidden to redirect the standard input of a `docker attach` command
4849
while attaching to a TTY-enabled container (using the `-i` and `-t` options).
@@ -51,16 +52,16 @@ While a client is connected to container's `stdio` using `docker attach`, Docker
5152
uses a ~1MB memory buffer to maximize the throughput of the application.
5253
Once this buffer is full, the speed of the API connection is affected, and so
5354
this impacts the output process' writing speed. This is similar to other
54-
applications like SSH. Because of this, it is not recommended to run
55-
performance critical applications that generate a lot of output in the
56-
foreground over a slow client connection. Instead, users should use the
55+
applications like SSH. Because of this, it isn't recommended to run
56+
performance-critical applications that generate a lot of output in the
57+
foreground over a slow client connection. Instead, use the
5758
`docker logs` command to get access to the logs.
5859

5960
## Examples
6061

6162
### Attach to and detach from a running container
6263

63-
The following example starts an ubuntu container running `top` in detached mode,
64+
The following example starts an Ubuntu container running `top` in detached mode,
6465
then attaches to the container;
6566

6667
```console

docs/reference/commandline/build.md

Lines changed: 28 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,11 @@ pre-packaged tarball contexts and plain text files.
6060

6161
When the `URL` parameter points to the location of a Git repository, the
6262
repository acts as the build context. The system recursively fetches the
63-
repository and its submodules. The commit history is not preserved. A
63+
repository and its submodules. The commit history isn't preserved. A
6464
repository is first pulled into a temporary directory on your local host. After
6565
that succeeds, the directory is sent to the Docker daemon as the context.
6666
Local copy gives you the ability to access private repositories using local
67-
user credentials, VPN's, and so forth.
67+
user credentials, VPNs, and so forth.
6868

6969
> **Note**
7070
>
@@ -100,18 +100,18 @@ contexts:
100100

101101
### Tarball contexts
102102

103-
If you pass an URL to a remote tarball, the URL itself is sent to the daemon:
103+
If you pass a URL to a remote tarball, the URL itself is sent to the daemon:
104104

105105
```console
106106
$ docker build http://server/context.tar.gz
107107
```
108108

109109
The download operation will be performed on the host the Docker daemon is
110-
running on, which is not necessarily the same host from which the build command
110+
running on, which isn't necessarily the same host from which the build command
111111
is being issued. The Docker daemon will fetch `context.tar.gz` and use it as the
112112
build context. Tarball contexts must be tar archives conforming to the standard
113-
`tar` UNIX format and can be compressed with any one of the 'xz', 'bzip2',
114-
'gzip' or 'identity' (no compression) formats.
113+
`tar` Unix format and can be compressed with any one of the `xz`, `bzip2`,
114+
`gzip` or `identity` (no compression) formats.
115115

116116
### Text files
117117

@@ -122,7 +122,7 @@ Instead of specifying a context, you can pass a single `Dockerfile` in the
122122
$ docker build - < Dockerfile
123123
```
124124

125-
With Powershell on Windows, you can run:
125+
With PowerShell on Windows, you can run:
126126

127127
```powershell
128128
Get-Content Dockerfile | docker build -
@@ -136,8 +136,7 @@ By default the `docker build` command will look for a `Dockerfile` at the root
136136
of the build context. The `-f`, `--file`, option lets you specify the path to
137137
an alternative file to use instead. This is useful in cases where the same set
138138
of files are used for multiple builds. The path must be to a file within the
139-
build context. If a relative path is specified then it is interpreted as
140-
relative to the root of the context.
139+
build context. Relative path are interpreted as relative to the root of the context.
141140

142141
In most cases, it's best to put each Dockerfile in an empty directory. Then,
143142
add to that directory only the files needed for building the Dockerfile. To
@@ -152,8 +151,7 @@ running at the time the build is cancelled, the pull is cancelled as well.
152151

153152
## Return code
154153

155-
On a successful build, a return code of success `0` will be returned. When the
156-
build fails, a non-zero failure code will be returned.
154+
Successful builds return exit code `0`. Failed builds return a non-zero exit code.
157155

158156
There should be informational output of the reason for failure output to
159157
`STDERR`:
@@ -214,15 +212,15 @@ local directory get `tar`d and sent to the Docker daemon. The `PATH` specifies
214212
where to find the files for the "context" of the build on the Docker daemon.
215213
Remember that the daemon could be running on a remote machine and that no
216214
parsing of the Dockerfile happens at the client side (where you're running
217-
`docker build`). That means that *all* the files at `PATH` get sent, not just
218-
the ones listed to [*ADD*](https://docs.docker.com/engine/reference/builder/#add)
215+
`docker build`). That means that all the files at `PATH` get sent, not just
216+
the ones listed to [`ADD`](https://docs.docker.com/engine/reference/builder/#add)
219217
in the Dockerfile.
220218

221219
The transfer of context from the local machine to the Docker daemon is what the
222220
`docker` client means when you see the "Sending build context" message.
223221

224222
If you wish to keep the intermediate containers after the build is complete,
225-
you must use `--rm=false`. This does not affect the build cache.
223+
you must use `--rm=false`. This doesn't affect the build cache.
226224

227225
### Build with URL
228226

@@ -252,7 +250,7 @@ Successfully built 377c409b35e4
252250

253251
This sends the URL `http://server/ctx.tar.gz` to the Docker daemon, which
254252
downloads and extracts the referenced tarball. The `-f ctx/Dockerfile`
255-
parameter specifies a path inside `ctx.tar.gz` to the `Dockerfile` that is used
253+
parameter specifies a path inside `ctx.tar.gz` to the `Dockerfile` used
256254
to build the image. Any `ADD` commands in that `Dockerfile` that refers to local
257255
paths must be relative to the root of the contents inside `ctx.tar.gz`. In the
258256
example above, the tarball contains a directory `ctx/`, so the `ADD
@@ -274,7 +272,7 @@ $ docker build - < context.tar.gz
274272
```
275273

276274
This will build an image for a compressed context read from `STDIN`. Supported
277-
formats are: bzip2, gzip and xz.
275+
formats are: `bzip2`, `gzip` and `xz`.
278276

279277
### Use a .dockerignore file
280278

@@ -314,7 +312,6 @@ found, the `.dockerignore` file is used if present. Using a Dockerfile based
314312
`.dockerignore` is useful if a project contains multiple Dockerfiles that expect
315313
to ignore different sets of files.
316314

317-
318315
### <a name="tag"></a> Tag an image (-t, --tag)
319316

320317
```console
@@ -375,12 +372,12 @@ the command line.
375372
> **Note**
376373
>
377374
> `docker build` returns a `no such file or directory` error if the
378-
> file or directory does not exist in the uploaded context. This may
379-
> happen if there is no context, or if you specify a file that is
375+
> file or directory doesn't exist in the uploaded context. This may
376+
> happen if there is no context, or if you specify a file that's
380377
> elsewhere on the Host system. The context is limited to the current
381378
> directory (and its children) for security reasons, and to ensure
382379
> repeatable builds on remote Docker hosts. This is also the reason why
383-
> `ADD ../file` does not work.
380+
> `ADD ../file` doesn't work.
384381
385382
### <a name="cgroup-parent"></a> Use a custom parent cgroup (--cgroup-parent)
386383

@@ -396,7 +393,7 @@ container to be started using those [`--ulimit` flag values](run.md#ulimit).
396393

397394
You can use `ENV` instructions in a Dockerfile to define variable
398395
values. These values persist in the built image. However, often
399-
persistence is not what you want. Users want to specify variables differently
396+
persistence isn't what you want. Users want to specify variables differently
400397
depending on which host they build an image on.
401398

402399
A good example is `http_proxy` or source versions for pulling intermediate
@@ -410,7 +407,7 @@ $ docker build --build-arg HTTP_PROXY=http://10.20.30.2:1234 --build-arg FTP_PRO
410407
This flag allows you to pass the build-time variables that are
411408
accessed like regular environment variables in the `RUN` instruction of the
412409
Dockerfile. Also, these values don't persist in the intermediate or final images
413-
like `ENV` values do. You must add `--build-arg` for each build argument.
410+
like `ENV` values do. You must add `--build-arg` for each build argument.
414411

415412
Using this flag will not alter the output you see when the `ARG` lines from the
416413
Dockerfile are echoed during the build process.
@@ -656,24 +653,24 @@ images (saving space).
656653

657654
For most use cases, multi-stage builds are a better alternative, as they give more
658655
fine-grained control over your build, and can take advantage of future
659-
optimizations in the builder. Refer to the [use multi-stage builds](https://docs.docker.com/develop/develop-images/multistage-build/)
660-
section in the userguide for more information.
656+
optimizations in the builder. Refer to the [Multi-stage builds](https://docs.docker.com/develop/develop-images/multistage-build/)
657+
section for more information.
661658

662659

663660
#### Known limitations
664661

665662
The `--squash` option has a number of known limitations:
666663

667-
- When squashing layers, the resulting image cannot take advantage of layer
664+
- When squashing layers, the resulting image can't take advantage of layer
668665
sharing with other images, and may use significantly more space. Sharing the
669666
base image is still supported.
670667
- When using this option you may see significantly more space used due to
671668
storing two copies of the image, one for the build cache with all the cache
672669
layers intact, and one for the squashed version.
673670
- While squashing layers may produce smaller images, it may have a negative
674671
impact on performance, as a single layer takes longer to extract, and
675-
downloading a single layer cannot be parallelized.
676-
- When attempting to squash an image that does not make changes to the
672+
downloading a single layer can't be parallelized.
673+
- When attempting to squash an image that doesn't make changes to the
677674
filesystem (for example, the Dockerfile only contains `ENV` instructions),
678675
the squash step will fail (see [issue #33823](https://github.com/moby/moby/issues/33823)).
679676

@@ -686,7 +683,7 @@ the Docker daemon or setting `experimental: true` in the `daemon.json` configura
686683
file.
687684

688685
By default, experimental mode is disabled. To see the current configuration of
689-
the docker daemon, use the `docker version` command and check the `Experimental`
686+
the Docker daemon, use the `docker version` command and check the `Experimental`
690687
line in the `Engine` section:
691688

692689
```console
@@ -711,10 +708,10 @@ Server: Docker Engine - Community
711708
[...]
712709
```
713710

714-
To enable experimental mode, users need to restart the docker daemon with the
711+
To enable experimental mode, users need to restart the Docker daemon with the
715712
experimental flag enabled.
716713

717-
#### Enable Docker experimental
714+
#### Enable experimental features
718715

719716
To enable experimental features, you need to start the Docker daemon with
720717
`--experimental` flag. You can also enable the daemon flag via
@@ -735,7 +732,7 @@ true
735732

736733
#### Build an image with `--squash` argument
737734

738-
The following is an example of docker build with `--squash` argument
735+
The following is an example of a build with `--squash` argument
739736

740737
```dockerfile
741738
FROM busybox

docs/reference/commandline/checkpoint.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Manage checkpoints
1818
## Description
1919

2020
Checkpoint and Restore is an experimental feature that allows you to freeze a running
21-
container by checkpointing it, which turns its state into a collection of files
21+
container by specifying a checkpoint, which turns the container state into a collection of files
2222
on disk. Later, the container can be restored from the point it was frozen.
2323

2424
This is accomplished using a tool called [CRIU](https://criu.org), which is an
@@ -29,7 +29,7 @@ checkpoint and restore in Docker is available in this
2929
### Installing CRIU
3030

3131
If you use a Debian system, you can add the CRIU PPA and install with `apt-get`
32-
[from the criu launchpad](https://launchpad.net/~criu/+archive/ubuntu/ppa).
32+
[from the CRIU launchpad](https://launchpad.net/~criu/+archive/ubuntu/ppa).
3333

3434
Alternatively, you can [build CRIU from source](https://criu.org/Installation).
3535

@@ -91,17 +91,17 @@ abc0123
9191
```
9292

9393
This process just logs an incrementing counter to stdout. If you run `docker logs`
94-
in between running/checkpoint/restoring you should see that the counter
95-
increases while the process is running, stops while it's checkpointed, and
94+
in-between running/checkpoint/restoring, you should see that the counter
95+
increases while the process is running, stops while it's frozen, and
9696
resumes from the point it left off once you restore.
9797

9898
### Known limitations
9999

100-
seccomp is only supported by CRIU in very up to date kernels.
100+
`seccomp` is only supported by CRIU in very up-to-date kernels.
101101

102-
External terminal (i.e. `docker run -t ..`) is not supported at the moment.
102+
External terminals (i.e. `docker run -t ..`) aren't supported.
103103
If you try to create a checkpoint for a container with an external terminal,
104-
it would fail:
104+
it fails:
105105

106106
```console
107107
$ docker checkpoint create cr checkpoint1

docs/reference/commandline/commit.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,21 +22,18 @@ Create a new image from a container's changes
2222
## Description
2323

2424
It can be useful to commit a container's file changes or settings into a new
25-
image. This allows you to debug a container by running an interactive shell, or to
26-
export a working dataset to another server. Generally, it is better to use
27-
Dockerfiles to manage your images in a documented and maintainable way.
28-
[Read more about valid image names and tags](tag.md).
25+
image. This lets you debug a container by running an interactive shell, or
26+
export a working dataset to another server.
2927

30-
The commit operation will not include any data contained in
31-
volumes mounted inside the container.
28+
Commits do not include any data contained in mounted volumes.
3229

3330
By default, the container being committed and its processes will be paused
3431
while the image is committed. This reduces the likelihood of encountering data
35-
corruption during the process of creating the commit. If this behavior is
32+
corruption during the process of creating the commit. If this behavior is
3633
undesired, set the `--pause` option to false.
3734

38-
The `--change` option will apply `Dockerfile` instructions to the image that is
39-
created. Supported `Dockerfile` instructions:
35+
The `--change` option will apply `Dockerfile` instructions to the image that's
36+
created. Supported `Dockerfile` instructions:
4037
`CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`LABEL`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`
4138

4239
## Examples

docs/reference/commandline/config_create.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ For detailed information about using configs, refer to [store configuration data
2121

2222
> **Note**
2323
>
24-
> This is a cluster management command, and must be executed on a swarm
24+
> This is a cluster management command, and must be executed on a Swarm
2525
> manager node. To learn about managers and workers, refer to the
2626
> [Swarm mode section](https://docs.docker.com/engine/swarm/) in the
2727
> documentation.
@@ -88,7 +88,6 @@ $ docker config inspect my_config
8888
]
8989
```
9090

91-
9291
## Related commands
9392

9493
* [config inspect](config_inspect.md)

docs/reference/commandline/config_inspect.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ For detailed information about using configs, refer to [store configuration data
2727

2828
> **Note**
2929
>
30-
> This is a cluster management command, and must be executed on a swarm
30+
> This is a cluster management command, and must be executed on a Swarm
3131
> manager node. To learn about managers and workers, refer to the
3232
> [Swarm mode section](https://docs.docker.com/engine/swarm/) in the
3333
> documentation.
@@ -86,7 +86,6 @@ $ docker config inspect --format='{{.CreatedAt}}' eo7jnzguqgtpdah3cm5srfb97
8686
2017-03-24 08:15:09.735271783 +0000 UTC
8787
```
8888

89-
9089
## Related commands
9190

9291
* [config create](config_create.md)

docs/reference/commandline/config_ls.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ List configs
2020

2121
## Description
2222

23-
Run this command on a manager node to list the configs in the swarm.
23+
Run this command on a manager node to list the configs in the Swarm.
2424

2525
For detailed information about using configs, refer to [store configuration data using Docker Configs](https://docs.docker.com/engine/swarm/configs/).
2626

2727
> **Note**
2828
>
29-
> This is a cluster management command, and must be executed on a swarm
29+
> This is a cluster management command, and must be executed on a Swarm
3030
> manager node. To learn about managers and workers, refer to the
3131
> [Swarm mode section](https://docs.docker.com/engine/swarm/) in the
3232
> documentation.

0 commit comments

Comments
 (0)