Skip to content

Commit 7aa132f

Browse files
committed
docs: man: rename config.toml(5) to be more descriptive
The man page namespace is global, so in order to avoid colliding with other man pages named "config.toml" rename ours to be more descriptive. This also helps with discoverability (now tab-completion of 'man containerd<tab>' will return the config man page), as well as making it much cleaner from the perspective of distributions that want to package containerd. Signed-off-by: Aleksa Sarai <[email protected]>
1 parent 1ba4aa0 commit 7aa132f

5 files changed

+13
-13
lines changed

Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ TEST_REQUIRES_ROOT_PACKAGES=$(filter \
7272

7373
# Project binaries.
7474
COMMANDS=ctr containerd containerd-stress containerd-release
75-
MANPAGES=ctr.1 containerd.1 config.toml.5 containerd-config.1
75+
MANPAGES=ctr.1 containerd.1 containerd-config.1 containerd-config.toml.5
7676

7777
# Build tags seccomp and apparmor are needed by CRI plugin.
7878
BUILDTAGS ?= seccomp apparmor

docs/man/containerd-config.1.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ The *containerd config* command has one subcommand, named *default*, which
1010
will display on standard output the default containerd config for this version
1111
of the containerd daemon.
1212

13-
This output can be piped to a __config.toml(5)__ file and placed in
13+
This output can be piped to a __containerd-config.toml(5)__ file and placed in
1414
**/etc/containerd** to be used as the configuration for containerd on daemon
1515
startup. The configuration can be placed in any filesystem location and used
1616
with the **--config** option to the containerd daemon as well.
1717

18-
See __config.toml(5)__ for more information on the containerd configuration
19-
options.
18+
See __containerd-config.toml(5)__ for more information on the containerd
19+
configuration options.
2020

2121
## OPTIONS
2222

@@ -34,4 +34,4 @@ Phil Estes <[email protected]>
3434

3535
## SEE ALSO
3636

37-
ctr(1), config.toml(5), containerd(1)
37+
ctr(1), containerd(1), containerd-config.toml(5)

docs/man/config.toml.5.md docs/man/containerd-config.toml.5.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# config.toml 5 02/02/2018
1+
# /etc/containerd/config.toml 5 08/08/2018
22

33
## SYNOPSIS
44

55
The **config.toml** file is a configuration file for the containerd daemon. The
6-
file must be placed in **/etc/containerd/** or used with the **--config**
7-
option of **containerd** to be used by the daemon. If the file does not exist
8-
at the appropriate location or is not provided via the **--config** option
9-
containerd uses its default configuration settings, which can be displayed
10-
with the **containerd config(1)** command.
6+
file must be placed at **/etc/containerd/config.toml** or specified with the
7+
**--config** option of **containerd** to be used by the daemon. If the file
8+
does not exist at the appropriate location or is not provided via the
9+
**--config** option containerd uses its default configuration settings, which
10+
can be displayed with the **containerd config(1)** command.
1111

1212
## DESCRIPTION
1313

docs/man/containerd.1.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@ Phil Estes <[email protected]>
5353

5454
## SEE ALSO
5555

56-
ctr(1), config.toml(5), containerd-config(1)
56+
ctr(1), containerd-config(1), containerd-config.toml(5)

docs/man/ctr.1.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,4 +91,4 @@ Phil Estes <[email protected]>
9191

9292
## SEE ALSO
9393

94-
containerd(1), config.toml(5), containerd-config(1)
94+
containerd(1), containerd-config(1), containerd-config.toml(5)

0 commit comments

Comments
 (0)