Skip to content
This repository was archived by the owner on Oct 13, 2023. It is now read-only.

Commit 5631277

Browse files
committed
reference docs: reformat notes
Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit 6ae5df423a29a2bc118d6613da6db5f72d9d12bb) Signed-off-by: Sebastiaan van Stijn <github@gone.nl> Upstream-commit: 6ba9a3e4c9bbcf940f333b47e2b1c82100144b2c Component: cli
1 parent 299fb4e commit 5631277

39 files changed

Lines changed: 246 additions & 129 deletions

components/cli/docs/reference/commandline/build.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,8 @@ that succeeds, the directory is sent to the Docker daemon as the context.
7878
Local copy gives you the ability to access private repositories using local
7979
user credentials, VPN's, and so forth.
8080

81-
> **Note:**
81+
> **Note**
82+
>
8283
> If the `URL` parameter contains a fragment the system will recursively clone
8384
> the repository and its submodules using a `git clone --recursive` command.
8485
@@ -577,7 +578,9 @@ $ ls ./out
577578
vndr
578579
```
579580

580-
> **Note**: This feature requires the BuildKit backend. You can either
581+
> **Note**
582+
>
583+
> This feature requires the BuildKit backend. You can either
581584
> [enable BuildKit](../builder.md#buildkit) or use the [buildx](https://github.com/docker/buildx)
582585
> plugin which provides more output type options.
583586
@@ -616,7 +619,9 @@ BuildKit automatically pulls the image from the registry if needed.
616619
$ docker build --cache-from myname/myapp .
617620
```
618621

619-
> **Note**: This feature requires the BuildKit backend. You can either
622+
> **Note**
623+
>
624+
> This feature requires the BuildKit backend. You can either
620625
> [enable BuildKit](../builder.md#buildkit) or use the [buildx](https://github.com/docker/buildx)
621626
> plugin. The previous builder has limited support for reusing cache from
622627
> pre-pulled images.

components/cli/docs/reference/commandline/cli.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,9 @@ Sometimes, multiple options can call for a more complex value string as for
402402
$ docker run -v /host:/container example/mysql
403403
```
404404

405-
> **Note**: Do not use the `-t` and `-a stderr` options together due to
405+
> **Note**
406+
>
407+
> Do not use the `-t` and `-a stderr` options together due to
406408
> limitations in the `pty` implementation. All `stderr` in `pty` mode
407409
> simply goes to `stdout`.
408410

components/cli/docs/reference/commandline/dockerd.md

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,10 @@ type `dockerd`.
107107
To run the daemon with debug output, use `dockerd -D` or add `"debug": true` to
108108
the `daemon.json` file.
109109

110-
> **Note**: In Docker 1.13 and higher, enable experimental features by starting
111-
> `dockerd` with the `--experimental` flag or adding `"experimental": true` to the
112-
> `daemon.json` file. In earlier Docker versions, a different build was required
113-
> to enable experimental features.
110+
> **Enabling experimental features**
111+
>
112+
> Enable experimental features by starting `dockerd` with the `--experimental`
113+
> flag or adding `"experimental": true` to the `daemon.json` file.
114114
115115
## Examples
116116

@@ -133,7 +133,9 @@ interface using its IP address: `-H tcp://192.168.59.103:2375`. It is
133133
conventional to use port `2375` for un-encrypted, and port `2376` for encrypted
134134
communication with the daemon.
135135

136-
> **Note**: If you're using an HTTPS encrypted socket, keep in mind that only
136+
> **Note**
137+
>
138+
> If you're using an HTTPS encrypted socket, keep in mind that only
137139
> TLS1.0 and greater are supported. Protocols SSLv3 and under are not
138140
> supported anymore for security reasons.
139141
@@ -298,20 +300,24 @@ The `overlay` is a very fast union filesystem. It is now merged in the main
298300
Linux kernel as of [3.18.0](https://lkml.org/lkml/2014/10/26/137). `overlay`
299301
also supports page cache sharing, this means multiple containers accessing
300302
the same file can share a single page cache entry (or entries), it makes
301-
`overlay` as efficient with memory as `aufs` driver. Call
302-
`dockerd -s overlay` to use it.
303-
304-
> **Note**: As promising as `overlay` is, the feature is still quite young and
305-
> should not be used in production. Most notably, using `overlay` can cause
306-
> excessive inode consumption (especially as the number of images grows), as
307-
> well as being incompatible with the use of RPMs.
303+
`overlay` as efficient with memory as `aufs` driver. Call `dockerd -s overlay`
304+
to use it.
308305

309306
The `overlay2` uses the same fast union filesystem but takes advantage of
310307
[additional features](https://lkml.org/lkml/2015/2/11/106) added in Linux
311308
kernel 4.0 to avoid excessive inode consumption. Call `dockerd -s overlay2`
312309
to use it.
313310

314-
> **Note**: Both `overlay` and `overlay2` are currently unsupported on `btrfs`
311+
> **Note**
312+
>
313+
> The `overlay` storage driver can cause excessive inode consumption (especially
314+
> as the number of images grows). We recommend using the `overlay2` storage
315+
> driver instead.
316+
317+
318+
> **Note**
319+
>
320+
> Both `overlay` and `overlay2` are currently unsupported on `btrfs`
315321
> or any Copy on Write filesystem and should only be used over `ext4` partitions.
316322
317323
On Windows, the Docker daemon supports a single image layer storage driver
@@ -458,7 +464,9 @@ $ sudo service docker start
458464

459465
##### `dm.loopdatasize`
460466

461-
> **Note**: This option configures devicemapper loopback, which should not
467+
> **Note**
468+
>
469+
> This option configures devicemapper loopback, which should not
462470
> be used in production.
463471
464472
Specifies the size to use when creating the loopback file for the
@@ -474,7 +482,9 @@ $ sudo dockerd --storage-opt dm.loopdatasize=200G
474482

475483
##### `dm.loopmetadatasize`
476484

477-
> **Note**: This option configures devicemapper loopback, which should not
485+
> **Note**
486+
>
487+
> This option configures devicemapper loopback, which should not
478488
> be used in production.
479489
480490
Specifies the size to use when creating the loopback file for the
@@ -621,7 +631,9 @@ $ sudo dockerd --storage-opt dm.override_udev_sync_check=true
621631
When this value is `true`, the `devicemapper` continues and simply warns
622632
you the errors are happening.
623633

624-
> **Note**: The ideal is to pursue a `docker` daemon and environment that does
634+
> **Note**
635+
>
636+
> The ideal is to pursue a `docker` daemon and environment that does
625637
> support synchronizing with `udev`. For further discussion on this
626638
> topic, see [docker#4036](https://github.com/docker/docker/issues/4036).
627639
> Otherwise, set this flag for migrating existing Docker daemons to
@@ -953,7 +965,9 @@ This is the same example via the command line:
953965
$ sudo dockerd --add-runtime runc=runc --add-runtime custom=/usr/local/bin/my-runc-replacement
954966
```
955967

956-
> **Note**: Defining runtime arguments via the command line is not supported.
968+
> **Note**
969+
>
970+
> Defining runtime arguments via the command line is not supported.
957971
958972
#### Options for the runtime
959973

components/cli/docs/reference/commandline/image_prune.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,9 @@ This example removes images which have a maintainer label not set to `john`:
190190
$ docker image prune --filter="label!=maintainer=john"
191191
```
192192

193-
> **Note**: You are prompted for confirmation before the `prune` removes
193+
> **Note**
194+
>
195+
> You are prompted for confirmation before the `prune` removes
194196
> anything, but you are not shown a list of what will potentially be removed.
195197
> In addition, `docker image ls` does not support negative filtering, so it
196198
> difficult to predict what images will actually be removed.

components/cli/docs/reference/commandline/images.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -184,8 +184,7 @@ dea752e4e117
184184
511136ea3c5a
185185
```
186186

187-
> **Note**: Docker warns you if any containers exist that are using these
188-
> untagged images.
187+
Docker warns you if any containers exist that are using these untagged images.
189188

190189

191190
#### Show images with a given label

components/cli/docs/reference/commandline/logs.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,10 @@ Options:
2525

2626
The `docker logs` command batch-retrieves logs present at the time of execution.
2727

28-
> **Note**: this command is only functional for containers that are started with
29-
> the `json-file` or `journald` logging driver.
28+
> **Note**
29+
>
30+
> This command is only functional for containers that are started with the
31+
> `json-file` or `journald` logging driver.
3032
3133
For more information about selecting and configuring logging drivers, refer to
3234
[Configure logging drivers](https://docs.docker.com/config/containers/logging/configure/).

components/cli/docs/reference/commandline/node_demote.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ Options:
2020

2121
Demotes an existing manager so that it is no longer a manager.
2222

23-
> **Note**: This is a cluster management command, and must be executed on a swarm
23+
> **Note**
24+
>
25+
> This is a cluster management command, and must be executed on a swarm
2426
> manager node. To learn about managers and workers, refer to the [Swarm mode
2527
> section](https://docs.docker.com/engine/swarm/) in the documentation.
2628

components/cli/docs/reference/commandline/node_inspect.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,12 @@ given template for each result. Go's
2525
[text/template](http://golang.org/pkg/text/template/) package describes all the
2626
details of the format.
2727

28-
> **Note**: This is a cluster management command, and must be executed on a swarm
29-
> manager node. To learn about managers and workers, refer to the [Swarm mode
30-
> section](https://docs.docker.com/engine/swarm/) in the documentation.
28+
> **Note**
29+
>
30+
> This is a cluster management command, and must be executed on a swarm
31+
> manager node. To learn about managers and workers, refer to the
32+
> [Swarm mode section](https://docs.docker.com/engine/swarm/) in the
33+
> documentation.
3134
3235
## Examples
3336

components/cli/docs/reference/commandline/node_ls.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,12 @@ Lists all the nodes that the Docker Swarm manager knows about. You can filter
2727
using the `-f` or `--filter` flag. Refer to the [filtering](#filtering) section
2828
for more information about available filter options.
2929

30-
> **Note**: This is a cluster management command, and must be executed on a swarm
31-
> manager node. To learn about managers and workers, refer to the [Swarm mode
32-
> section](https://docs.docker.com/engine/swarm/) in the documentation.
30+
> **Note**
31+
>
32+
> This is a cluster management command, and must be executed on a swarm
33+
> manager node. To learn about managers and workers, refer to the
34+
> [Swarm mode section](https://docs.docker.com/engine/swarm/) in the
35+
> documentation.
3336
3437
## Examples
3538

@@ -41,10 +44,11 @@ ID HOSTNAME STATUS AVAILABILITY MANAGER STATU
4144
38ciaotwjuritcdtn9npbnkuz swarm-worker1 Ready Active
4245
e216jshn25ckzbvmwlnh5jr3g * swarm-manager1 Ready Active Leader
4346
```
44-
> **Note**:
45-
> In the above example output, there is a hidden column of `.Self` that indicates if the
46-
> node is the same node as the current docker daemon. A `*` (e.g., `e216jshn25ckzbvmwlnh5jr3g *`)
47-
> means this node is the current docker daemon.
47+
> **Note**
48+
>
49+
> In the above example output, there is a hidden column of `.Self` that indicates
50+
> if the node is the same node as the current docker daemon. A `*` (e.g.,
51+
> `e216jshn25ckzbvmwlnh5jr3g *`) means this node is the current docker daemon.
4852
4953

5054
### Filtering

components/cli/docs/reference/commandline/node_promote.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,12 @@ Options:
1919

2020
Promotes a node to manager. This command can only be executed on a manager node.
2121

22-
> **Note**: This is a cluster management command, and must be executed on a swarm
23-
> manager node. To learn about managers and workers, refer to the [Swarm mode
24-
> section](https://docs.docker.com/engine/swarm/) in the documentation.
22+
> **Note**
23+
>
24+
> This is a cluster management command, and must be executed on a swarm
25+
> manager node. To learn about managers and workers, refer to the
26+
> [Swarm mode section](https://docs.docker.com/engine/swarm/) in the
27+
> documentation.
2528
2629
## Examples
2730

0 commit comments

Comments
 (0)