github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

docs: man: rename config.toml(5) to be more descriptive

Browse Source 
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 <asarai@suse.de>
This commit is contained in:
Aleksa Sarai 2018-08-08 18:15:00 +10:00
parent 1ba4aa04b4
commit 7aa132ffc7
No known key found for this signature in database
GPG Key ID: 9E18AA267DDB8DB4
5 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -72,7 +72,7 @@ TEST_REQUIRES_ROOT_PACKAGES=$(filter \
# Project binaries. # Project binaries.
COMMANDS=ctr containerd containerd-stress containerd-release COMMANDS=ctr containerd containerd-stress containerd-release
MANPAGES=ctr.1 containerd.1 config.toml.5 containerd-config.1 MANPAGES=ctr.1 containerd.1 containerd-config.1 containerd-config.toml.5
# Build tags seccomp and apparmor are needed by CRI plugin. # Build tags seccomp and apparmor are needed by CRI plugin.
BUILDTAGS ?= seccomp apparmor BUILDTAGS ?= seccomp apparmor

8
docs/man/containerd-config.1.md
View File

@ -10,13 +10,13 @@ The *containerd config* command has one subcommand, named *default*, which
will display on standard output the default containerd config for this version will display on standard output the default containerd config for this version
of the containerd daemon. of the containerd daemon.
This output can be piped to a __config.toml(5)__ file and placed in This output can be piped to a __containerd-config.toml(5)__ file and placed in
**/etc/containerd** to be used as the configuration for containerd on daemon **/etc/containerd** to be used as the configuration for containerd on daemon
startup. The configuration can be placed in any filesystem location and used startup. The configuration can be placed in any filesystem location and used
with the **--config** option to the containerd daemon as well. with the **--config** option to the containerd daemon as well.
See __config.toml(5)__ for more information on the containerd configuration See __containerd-config.toml(5)__ for more information on the containerd
options. configuration options.
## OPTIONS ## OPTIONS
@ -34,4 +34,4 @@ Phil Estes <estesp@gmail.com>
## SEE ALSO ## SEE ALSO
ctr(1), config.toml(5), containerd(1) ctr(1), containerd(1), containerd-config.toml(5)

12
docs/man/config.toml.5.md → docs/man/containerd-config.toml.5.md
View File

@ -1,13 +1,13 @@
# config.toml 5 02/02/2018 # /etc/containerd/config.toml 5 08/08/2018
## SYNOPSIS ## SYNOPSIS
The **config.toml** file is a configuration file for the containerd daemon. The The **config.toml** file is a configuration file for the containerd daemon. The
file must be placed in **/etc/containerd/** or used with the **--config** file must be placed at **/etc/containerd/config.toml** or specified with the
option of **containerd** to be used by the daemon. If the file does not exist **--config** option of **containerd** to be used by the daemon. If the file
at the appropriate location or is not provided via the **--config** option does not exist at the appropriate location or is not provided via the
containerd uses its default configuration settings, which can be displayed **--config** option containerd uses its default configuration settings, which
with the **containerd config(1)** command. can be displayed with the **containerd config(1)** command.
## DESCRIPTION ## DESCRIPTION

2
docs/man/containerd.1.md
View File

@ -53,4 +53,4 @@ Phil Estes <estesp@gmail.com>
## SEE ALSO ## SEE ALSO
ctr(1), config.toml(5), containerd-config(1) ctr(1), containerd-config(1), containerd-config.toml(5)

2
docs/man/ctr.1.md
View File

@ -91,4 +91,4 @@ Phil Estes <estesp@gmail.com>
## SEE ALSO ## SEE ALSO
containerd(1), config.toml(5), containerd-config(1) containerd(1), containerd-config(1), containerd-config.toml(5)