From fb8048371146a5521c49284b45b0f228f2e27879 Mon Sep 17 00:00:00 2001 From: Shengjing Zhu Date: Fri, 22 Feb 2019 02:05:34 +0800 Subject: [PATCH] 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 --- docs/man/containerd-config.1.md | 4 ++++ docs/man/containerd-config.toml.5.md | 4 ++++ docs/man/containerd.1.md | 5 +++++ docs/man/ctr.1.md | 4 ++++ 4 files changed, 17 insertions(+) diff --git a/docs/man/containerd-config.1.md b/docs/man/containerd-config.1.md index 8960b0a8b..9d59b423f 100644 --- a/docs/man/containerd-config.1.md +++ b/docs/man/containerd-config.1.md @@ -1,5 +1,9 @@ # containerd-config 1 01/30/2018 +## NAME + +containerd-config - information on the containerd config + ## SYNOPSIS containerd config [command] diff --git a/docs/man/containerd-config.toml.5.md b/docs/man/containerd-config.toml.5.md index b9c1edbde..21a603cea 100644 --- a/docs/man/containerd-config.toml.5.md +++ b/docs/man/containerd-config.toml.5.md @@ -1,5 +1,9 @@ # /etc/containerd/config.toml 5 08/08/2018 +## NAME + +containerd-config.toml - configuration file for containerd + ## SYNOPSIS The **config.toml** file is a configuration file for the containerd daemon. The diff --git a/docs/man/containerd.1.md b/docs/man/containerd.1.md index 691c909eb..137607ea8 100644 --- a/docs/man/containerd.1.md +++ b/docs/man/containerd.1.md @@ -1,5 +1,10 @@ # containerd 1 01/29/2018 +## NAME + +containerd - an industry-standard container runtime with an emphasis on simplicity, +robustness and portability + ## SYNOPSIS containerd [global options] command [command options] [arguments...] diff --git a/docs/man/ctr.1.md b/docs/man/ctr.1.md index 1febde5b4..8a8057f52 100644 --- a/docs/man/ctr.1.md +++ b/docs/man/ctr.1.md @@ -1,5 +1,9 @@ # ctr 1 01/30/2018 +## NAME + +ctr - command line for containerd + ## SYNOPSIS **ctr [global options] command [command options] [arguments...]**