github/containerd
4
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
5 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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
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
startup. The configuration can be placed in any filesystem location and used
with the **--config** option to the containerd daemon as well.
See __config.toml(5)__ for more information on the containerd configuration
options.
See __containerd-config.toml(5)__ for more information on the containerd
configuration options.
## OPTIONS
@@ -34,4 +34,4 @@ Phil Estes <estesp@gmail.com>
## SEE ALSO
ctr(1), config.toml(5), containerd(1)
ctr(1), containerd(1), containerd-config.toml(5)