docs/reference: explain "colon"

Colon may not be something non-native English readers
know about, so explain the symbol in the running text.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2020-04-19 17:23:09 +02:00
parent e4fc8cfa23
commit e34c407516
No known key found for this signature in database
GPG Key ID: 76698F39D527CE8C
19 changed files with 21 additions and 19 deletions

View File

@ -84,7 +84,7 @@ user credentials, VPN's, and so forth.
> the repository and its submodules using a `git clone --recursive` command. > the repository and its submodules using a `git clone --recursive` command.
Git URLs accept context configuration in their fragment section, separated by a Git URLs accept context configuration in their fragment section, separated by a
colon `:`. The first part represents the reference that Git will check out, colon (`:`). The first part represents the reference that Git will check out,
and can be either a branch, a tag, or a remote reference. The second part and can be either a branch, a tag, or a remote reference. The second part
represents a subdirectory inside the repository that will be used as a build represents a subdirectory inside the repository that will be used as a build
context. context.

View File

@ -68,7 +68,8 @@ output the data exactly as the template declares or, when using the
`table` directive, will include column headers as well. `table` directive, will include column headers as well.
The following example uses a template without headers and outputs the The following example uses a template without headers and outputs the
`ID` and `CreatedSince` entries separated by a colon for the `busybox` image: `ID` and `CreatedSince` entries separated by a colon (`:`) for the `busybox`
image:
```bash ```bash
$ docker history --format "{{.ID}}: {{.CreatedSince}}" busybox $ docker history --format "{{.ID}}: {{.CreatedSince}}" busybox

View File

@ -308,7 +308,7 @@ output the data exactly as the template declares or, when using the
`table` directive, will include column headers as well. `table` directive, will include column headers as well.
The following example uses a template without headers and outputs the The following example uses a template without headers and outputs the
`ID` and `Repository` entries separated by a colon for all images: `ID` and `Repository` entries separated by a colon (`:`) for all images:
```bash ```bash
$ docker images --format "{{.ID}}: {{.Repository}}" $ docker images --format "{{.ID}}: {{.Repository}}"

View File

@ -221,7 +221,7 @@ output the data exactly as the template declares or, when using the
`table` directive, includes column headers as well. `table` directive, includes column headers as well.
The following example uses a template without headers and outputs the The following example uses a template without headers and outputs the
`ID` and `Driver` entries separated by a colon for all networks: `ID` and `Driver` entries separated by a colon (`:`) for all networks:
```bash ```bash
$ docker network ls --format "{{.ID}}: {{.Driver}}" $ docker network ls --format "{{.ID}}: {{.Driver}}"

View File

@ -152,7 +152,8 @@ output the data exactly as the template declares or, when using the
`table` directive, includes column headers as well. `table` directive, includes column headers as well.
The following example uses a template without headers and outputs the The following example uses a template without headers and outputs the
`ID`, `Hostname`, and `TLS Status` entries separated by a colon for all nodes: `ID`, `Hostname`, and `TLS Status` entries separated by a colon (`:`) for all
nodes:
```bash ```bash
$ docker node ls --format "{{.ID}}: {{.Hostname}} {{.TLSStatus}}" $ docker node ls --format "{{.ID}}: {{.Hostname}} {{.TLSStatus}}"

View File

@ -130,7 +130,7 @@ output the data exactly as the template declares or, when using the
`table` directive, includes column headers as well. `table` directive, includes column headers as well.
The following example uses a template without headers and outputs the The following example uses a template without headers and outputs the
`Name` and `Image` entries separated by a colon for all tasks: `Name` and `Image` entries separated by a colon (`:`) for all tasks:
```bash ```bash
$ docker node ps --format "{{.Name}}: {{.Image}}" $ docker node ps --format "{{.Name}}: {{.Image}}"

View File

@ -88,7 +88,7 @@ output the data exactly as the template declares or, when using the
`table` directive, includes column headers as well. `table` directive, includes column headers as well.
The following example uses a template without headers and outputs the The following example uses a template without headers and outputs the
`ID` and `Name` entries separated by a colon for all plugins: `ID` and `Name` entries separated by a colon (`:`) for all plugins:
```bash ```bash
$ docker plugin ls --format "{{.ID}}: {{.Name}}" $ docker plugin ls --format "{{.ID}}: {{.Name}}"

View File

@ -421,7 +421,7 @@ exactly as the template declares or, when using the `table` directive, includes
column headers as well. column headers as well.
The following example uses a template without headers and outputs the `ID` and The following example uses a template without headers and outputs the `ID` and
`Command` entries separated by a colon for all running containers: `Command` entries separated by a colon (`:`) for all running containers:
```bash ```bash
$ docker ps --format "{{.ID}}: {{.Command}}" $ docker ps --format "{{.ID}}: {{.Command}}"

View File

@ -152,7 +152,7 @@ output the data exactly as the template declares. If you use the
`table` directive, column headers are included as well. `table` directive, column headers are included as well.
The following example uses a template without headers and outputs the The following example uses a template without headers and outputs the
`Name` and `StarCount` entries separated by a colon for all images: `Name` and `StarCount` entries separated by a colon (`:`) for all images:
```bash ```bash
$ docker search --format "{{.Name}}: {{.StarCount}}" nginx $ docker search --format "{{.Name}}: {{.StarCount}}" nginx

View File

@ -126,7 +126,7 @@ output the data exactly as the template declares or, when using the
`table` directive, will include column headers as well. `table` directive, will include column headers as well.
The following example uses a template without headers and outputs the The following example uses a template without headers and outputs the
`ID` and `Name` entries separated by a colon for all images: `ID` and `Name` entries separated by a colon (`:`) for all images:
```bash ```bash
$ docker secret ls --format "{{.ID}}: {{.Name}}" $ docker secret ls --format "{{.ID}}: {{.Name}}"

View File

@ -926,7 +926,7 @@ Long form syntax of `--network` allows to specify list of aliases and driver opt
You can publish service ports to make them available externally to the swarm You can publish service ports to make them available externally to the swarm
using the `--publish` flag. The `--publish` flag can take two different styles using the `--publish` flag. The `--publish` flag can take two different styles
of arguments. The short version is positional, and allows you to specify the of arguments. The short version is positional, and allows you to specify the
published port and target port separated by a colon. published port and target port separated by a colon (`:`).
```bash ```bash
$ docker service create --name my_web --replicas 3 --publish 8080:80 nginx $ docker service create --name my_web --replicas 3 --publish 8080:80 nginx

View File

@ -141,7 +141,7 @@ output the data exactly as the template declares or, when using the
`table` directive, includes column headers as well. `table` directive, includes column headers as well.
The following example uses a template without headers and outputs the The following example uses a template without headers and outputs the
`ID`, `Mode`, and `Replicas` entries separated by a colon for all services: `ID`, `Mode`, and `Replicas` entries separated by a colon (`:`) for all services:
```bash ```bash
$ docker service ls --format "{{.ID}}: {{.Mode}} {{.Replicas}}" $ docker service ls --format "{{.ID}}: {{.Mode}} {{.Replicas}}"

View File

@ -171,7 +171,7 @@ output the data exactly as the template declares or, when using the
`table` directive, includes column headers as well. `table` directive, includes column headers as well.
The following example uses a template without headers and outputs the The following example uses a template without headers and outputs the
`Name` and `Image` entries separated by a colon for all tasks: `Name` and `Image` entries separated by a colon (`:`) for all tasks:
```bash ```bash
$ docker service ps --format "{{.Name}}: {{.Image}}" top $ docker service ps --format "{{.Name}}: {{.Image}}" top

View File

@ -63,7 +63,7 @@ the data exactly as the template declares or, when using the
`table` directive, includes column headers as well. `table` directive, includes column headers as well.
The following example uses a template without headers and outputs the The following example uses a template without headers and outputs the
`Name` and `Services` entries separated by a colon for all stacks: `Name` and `Services` entries separated by a colon (`:`) for all stacks:
```bash ```bash
$ docker stack ls --format "{{.Name}}: {{.Services}}" $ docker stack ls --format "{{.Name}}: {{.Services}}"

View File

@ -140,7 +140,7 @@ output the data exactly as the template declares or, when using the
`table` directive, includes column headers as well. `table` directive, includes column headers as well.
The following example uses a template without headers and outputs the The following example uses a template without headers and outputs the
`Name` and `Image` entries separated by a colon for all tasks: `Name` and `Image` entries separated by a colon (`:`) for all tasks:
```bash ```bash
$ docker stack ps --format "{{.Name}}: {{.Image}}" voting $ docker stack ps --format "{{.Name}}: {{.Image}}" voting

View File

@ -101,7 +101,7 @@ output the data exactly as the template declares or, when using the
`table` directive, includes column headers as well. `table` directive, includes column headers as well.
The following example uses a template without headers and outputs the The following example uses a template without headers and outputs the
`ID`, `Mode`, and `Replicas` entries separated by a colon for all services: `ID`, `Mode`, and `Replicas` entries separated by a colon (`:`) for all services:
```bash ```bash
$ docker stack services --format "{{.ID}}: {{.Mode}} {{.Replicas}}" $ docker stack services --format "{{.ID}}: {{.Mode}} {{.Replicas}}"

View File

@ -149,7 +149,7 @@ outputs the data exactly as the template declares or, when using the
`table` directive, includes column headers as well. `table` directive, includes column headers as well.
The following example uses a template without headers and outputs the The following example uses a template without headers and outputs the
`Container` and `CPUPerc` entries separated by a colon for all images: `Container` and `CPUPerc` entries separated by a colon (`:`) for all images:
```bash ```bash
$ docker stats --format "{{.Container}}: {{.CPUPerc}}" $ docker stats --format "{{.Container}}: {{.CPUPerc}}"

View File

@ -99,7 +99,7 @@ the data exactly as the template declares or, when using the
`table` directive, will include column headers as well. `table` directive, will include column headers as well.
The following example uses a template without headers and outputs the The following example uses a template without headers and outputs the
`Type` and `TotalCount` entries separated by a colon: `Type` and `TotalCount` entries separated by a colon (`:`):
```bash ```bash
$ docker system df --format "{{.Type}}: {{.TotalCount}}" $ docker system df --format "{{.Type}}: {{.TotalCount}}"

View File

@ -171,7 +171,7 @@ output the data exactly as the template declares or, when using the
`table` directive, includes column headers as well. `table` directive, includes column headers as well.
The following example uses a template without headers and outputs the The following example uses a template without headers and outputs the
`Name` and `Driver` entries separated by a colon for all volumes: `Name` and `Driver` entries separated by a colon (`:`) for all volumes:
```bash ```bash
$ docker volume ls --format "{{.Name}}: {{.Driver}}" $ docker volume ls --format "{{.Name}}: {{.Driver}}"