Commit Graph

10 Commits

Author SHA1 Message Date
Sebastiaan van Stijn
ad090e67e9
man: move ctr.1, containerd-config to section 8, and fix generation
I missed this in my previous change: the ctr man page is also
in Section 8, because it's considered an administrative tool,
and containerd-config is related to containerd so updating these
as well.

This commit also fixes naming of the generated files, which was
hard-coded to .1.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-03 12:32:52 +02:00
Sebastiaan van Stijn
356782cb47
Makefile: man page: rename containerd.1 to containerd.8
The generated file was incorrectly named containerd.1 and should
be in section 8 (see [MAN-PAGES(7)]: Sections of the manual pages)

This patch fixes the filename and updates references to containerd(1)
to refer to containerd(8).

The generated file itself already had the correct section set in its
header, so didn't need updating.

[MAN-PAGES(7)]: http://man7.org/linux/man-pages/man7/man-pages.7.html

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-02 13:52:06 +02:00
Mihai Coman
5e6d56ee2d Fix startup_delay within default configuration
Without this patch, the containerd daemon fails to start using the
default configuration example:
containerd[37139]: containerd: time: missing unit in duration 100000000

Signed-off-by: Mihai Coman <mihai.cmn@gmail.com>
2020-01-29 15:34:23 +02:00
Lantao Liu
aaccfcbe2b Fix containerd config dump.
Signed-off-by: Lantao Liu <lantaol@google.com>
2019-10-23 22:38:18 -07:00
Michael Crosby
f3a5b8c0a9 Add command to generate man pages
The climan package has a command that can be registered with any urfav
cli app to generate man pages.

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2019-09-11 15:31:02 -04:00
Maksym Pavlenko
ea6c749e35 Update config doc
Signed-off-by: Maksym Pavlenko <makpav@amazon.com>
2019-08-23 11:08:25 -07:00
BoWen Yan
d15a06b190 docs: Fix typo to some markdown files in /docs.
Signed-off-by: BoWen Yan <loneybw@gmail.com>
2019-06-13 15:29:12 +08:00
Shengjing Zhu
fb80483711 docs: Add NAME section in all manpages
As described in https://lintian.debian.org/tags/manpage-has-bad-whatis-entry.html
each manual page should start with a "NAME" section.

Signed-off-by: Shengjing Zhu <zhsj@debian.org>
2019-02-22 23:40:28 +08:00
Aleksa Sarai
7aa132ffc7
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 <asarai@suse.de>
2018-08-08 18:33:29 +10:00
Phil Estes
8f183b5ee9
Add basic manpages for ctr, containerd, containerd-config
Adds initial manpages for ctr, containerd, and containerd config
commands, as well as the config.toml configuration file.

Adds targets to Makefile for generating and installing manpages.

Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2018-02-14 15:17:31 -05:00