Skip to content

Fix styling of arguments #4022

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
thaJeztah merged 1 commit into from
Apr 12, 2023
Merged

Fix styling of arguments #4022

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions man/dockerd.8.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ $ sudo dockerd --add-runtime runc=runc --add-runtime custom=/usr/local/bin/my-ru
Set parent cgroup for all containers. Default is "/docker" for fs cgroup
driver and "system.slice" for systemd cgroup driver.

**--config-file**="/etc/docker/daemon.json"
**--config-file**=*"/etc/docker/daemon.json"*
Copy link
Contributor

@kolyshkin kolyshkin Apr 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. This is wrong to put a default value (like done here) or an example value in synopsis. The proper way would be to say something like
**--config-file**=*"path"*

and add

Default is  */etc/docker/daemon.json*.

to the option description.

Copy link
Contributor

@kolyshkin kolyshkin Apr 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To explain the last part -- while a file name (such as /etc/docker/daemon.json) is a literal, the man page convention is to typeset it as italic.

Specifies the JSON file path to load the configuration from.

**--containerd**=""
Expand All @@ -165,7 +165,7 @@ $ sudo dockerd --add-runtime runc=runc --add-runtime custom=/usr/local/bin/my-ru
**-D**, **--debug**=*true*|*false*
Enable debug mode. Default is false.

**--default-cgroupns-mode**="**host**|**private**"
**--default-cgroupns-mode**="*host*|*private*"
Copy link
Contributor

@kolyshkin kolyshkin Apr 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here, both host and private are literals, i.e. they should be used as-is. Therefore, those are typeset in bold and should not be changed.

OTOH, if that would be something like default-cgroup-mode=MODE, the MODE should be in italic, as it's a value to be substituted.

Set the default cgroup namespace mode for newly created containers. The argument
can either be **host** or **private**. If unset, this defaults to `host` on cgroup v1,
`private` on cgroup v2.
Expand All @@ -182,10 +182,10 @@ $ sudo dockerd --add-runtime runc=runc --add-runtime custom=/usr/local/bin/my-ru
Example: base=172.30.0.0/16,size=24 will set the default
address pools for the selected scope networks to {172.30.[0-255].0/24}

**--default-runtime**="runc"
**--default-runtime**=*"runc"*
Set default runtime if there're more than one specified by `--add-runtime`.

**--default-ipc-mode**="**private**|**shareable**"
**--default-ipc-mode**="*private*|*shareable*"
Set the default IPC mode for newly created containers. The argument
can either be **private** or **shareable**.

Expand Down