Skip to content

Commit e3cb324

Browse files
committed
man/dockerd.8: escape asterisks and underscores
1. Escape asterisks and underscores, that have special meaning in Markdown. While most markdown processors are smart enough to distinguish whether it's a literal * or _ or a formatting directive, escaping makes things more explicit. 2. Fix using wrong level of headings in some dm options (most are ####, but some were #####). 3. Do not use sub-heading for examples in some dm options (this is how it's done in the rest of the man page). Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
1 parent 67c4570 commit e3cb324

1 file changed

Lines changed: 27 additions & 27 deletions

File tree

man/dockerd.8.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ $ sudo dockerd --add-runtime runc=runc --add-runtime custom=/usr/local/bin/my-ru
137137

138138
**--api-cors-header**=""
139139
Set CORS headers in the Engine API. Default is cors disabled. Give urls like
140-
"http://foo, http://bar, ...". Give "*" to allow all.
140+
"http://foo, http://bar, ...". Give "\*" to allow all.
141141

142142
**--authorization-plugin**=""
143143
Set authorization plugins to load
@@ -175,7 +175,7 @@ $ sudo dockerd --add-runtime runc=runc --add-runtime custom=/usr/local/bin/my-ru
175175

176176
**--default-gateway**=""
177177
IPv4 address of the container default gateway; this address must be part of
178-
the bridge subnet (which is defined by \-b or \--bip)
178+
the bridge subnet (which is defined by \-b or \-\-bip)
179179

180180
**--default-gateway-v6**=""
181181
IPv6 address of the container default gateway
@@ -231,7 +231,7 @@ $ sudo dockerd --add-runtime runc=runc --add-runtime custom=/usr/local/bin/my-ru
231231
**-H**, **--host**=[*unix:///var/run/docker.sock*]: tcp://[host:port] to bind or
232232
unix://[/path/to/socket] to use.
233233
The socket(s) to bind to in daemon mode specified using one or more
234-
tcp://host:port, unix:///path/to/socket, fd://* or fd://socketfd.
234+
tcp://host:port, unix:///path/to/socket, fd://\* or fd://socketfd.
235235

236236
**--help**
237237
Print usage statement
@@ -463,7 +463,7 @@ Example use:
463463
$ dockerd \
464464
--storage-opt dm.thinpooldev=/dev/mapper/thin-pool
465465

466-
#### dm.directlvm_device
466+
#### dm.directlvm\_device
467467

468468
As an alternative to manually creating a thin pool as above, Docker can
469469
automatically configure a block device for you.
@@ -473,40 +473,40 @@ Example use:
473473
$ dockerd \
474474
--storage-opt dm.directlvm_device=/dev/xvdf
475475

476-
##### dm.thinp_percent
476+
#### dm.thinp\_percent
477477

478478
Sets the percentage of passed in block device to use for storage.
479479

480-
###### Example:
480+
Example:
481481

482482
$ sudo dockerd \
483483
--storage-opt dm.thinp_percent=95
484484

485-
##### `dm.thinp_metapercent`
485+
#### dm.thinp\_metapercent
486486

487487
Sets the percentage of the passed in block device to use for metadata storage.
488488

489-
###### Example:
489+
Example:
490490

491491
$ sudo dockerd \
492492
--storage-opt dm.thinp_metapercent=1
493493

494-
##### dm.thinp_autoextend_threshold
494+
#### dm.thinp\_autoextend\_threshold
495495

496496
Sets the value of the percentage of space used before `lvm` attempts to
497497
autoextend the available space [100 = disabled]
498498

499-
###### Example:
499+
Example:
500500

501501
$ sudo dockerd \
502502
--storage-opt dm.thinp_autoextend_threshold=80
503503

504-
##### dm.thinp_autoextend_percent
504+
#### dm.thinp\_autoextend\_percent
505505

506506
Sets the value percentage value to increase the thin pool by when `lvm`
507507
attempts to autoextend the available space [100 = disabled]
508508

509-
###### Example:
509+
Example:
510510

511511
$ sudo dockerd \
512512
--storage-opt dm.thinp_autoextend_percent=20
@@ -559,7 +559,7 @@ Specifies extra mount options used when mounting the thin devices.
559559

560560
Example use: `dockerd --storage-opt dm.mountopt=nodiscard`
561561

562-
#### dm.use_deferred_removal
562+
#### dm.use\_deferred\_removal
563563

564564
Enables use of deferred device removal if `libdm` and the kernel driver
565565
support the mechanism.
@@ -577,7 +577,7 @@ busy device.
577577

578578
Example use: `dockerd --storage-opt dm.use_deferred_removal=true`
579579

580-
#### dm.use_deferred_deletion
580+
#### dm.use\_deferred\_deletion
581581

582582
Enables use of deferred device deletion for thin pool devices. By default,
583583
thin pool device deletion is synchronous. Before a container is deleted, the
@@ -656,7 +656,7 @@ returned to the system for other use when containers are removed.
656656

657657
Example use: `dockerd --storage-opt dm.blkdiscard=false`
658658

659-
#### dm.override_udev_sync_check
659+
#### dm.override\_udev\_sync\_check
660660

661661
By default, the devicemapper backend attempts to synchronize with the `udev`
662662
device manager for the Linux kernel. This option allows disabling that
@@ -692,7 +692,7 @@ support synchronizing with `udev`. For further discussion on this topic, see
692692
Otherwise, set this flag for migrating existing Docker daemons to a daemon with
693693
a supported environment.
694694

695-
#### dm.min_free_space
695+
#### dm.min\_free\_space
696696

697697
Specifies the min free space percent in a thin pool require for new device
698698
creation to succeed. This check applies to both free data space as well
@@ -717,7 +717,7 @@ the issue.
717717

718718
Example use:: `dockerd --storage-opt dm.min_free_space=10%`
719719

720-
#### dm.xfs_nospace_max_retries
720+
#### dm.xfs\_nospace\_max\_retries
721721

722722
Specifies the maximum number of retries XFS should attempt to complete IO when
723723
ENOSPC (no space) error is returned by underlying storage device.
@@ -731,7 +731,7 @@ Example use:
731731

732732
$ sudo dockerd --storage-opt dm.xfs_nospace_max_retries=0
733733

734-
##### dm.libdm_log_level
734+
##### dm.libdm\_log\_level
735735

736736
Specifies the maxmimum libdm log level that will be forwarded to the dockerd
737737
log (as specified by --log-level). This option is primarily intended for
@@ -742,14 +742,14 @@ Values specified must fall within the range of valid libdm log levels. At the
742742
time of writing, the following is the list of libdm log levels as well as their
743743
corresponding levels when output by dockerd.
744744

745-
| libdm Level | Value | --log-level |
746-
| ----------- | -----:| ----------- |
747-
| _LOG_FATAL | 2 | error |
748-
| _LOG_ERR | 3 | error |
749-
| _LOG_WARN | 4 | warn |
750-
| _LOG_NOTICE | 5 | info |
751-
| _LOG_INFO | 6 | info |
752-
| _LOG_DEBUG | 7 | debug |
745+
| libdm Level | Value | --log-level |
746+
| ------------- | -----:| ----------- |
747+
| \_LOG\_FATAL | 2 | error |
748+
| \_LOG\_ERR | 3 | error |
749+
| \_LOG\_WARN | 4 | warn |
750+
| \_LOG\_NOTICE | 5 | info |
751+
| \_LOG\_INFO | 6 | info |
752+
| \_LOG\_DEBUG | 7 | debug |
753753

754754
Example use:
755755

@@ -769,7 +769,7 @@ Example use: `dockerd -s zfs --storage-opt zfs.fsname=zroot/docker`
769769

770770
## Btrfs options
771771

772-
#### btrfs.min_space
772+
#### btrfs.min\_space
773773

774774
Specifies the minimum size to use when creating the subvolume which is used for
775775
containers. If user uses disk quota for btrfs when creating or running a

0 commit comments

Comments
 (0)