File 0001-docs-man-rename-config.toml-5-to-be-more-d... of Package containerd.9604

Overview Repositories Revisions Requests Users Attributes Meta

File 0001-docs-man-rename-config.toml-5-to-be-more-descriptive.patch of Package containerd.9604

From 7aa132ffc732e445a7673d1dd0612d32737cd0dd Mon Sep 17 00:00:00 2001
From: Aleksa Sarai <asarai@suse.de>
Date: Wed, 8 Aug 2018 18:15:00 +1000
Subject: [PATCH] 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>
---
 Makefile                                             |  2 +-
 docs/man/containerd-config.1.md                      |  8 ++++----
 ...{config.toml.5.md => containerd-config.toml.5.md} | 12 ++++++------
 docs/man/containerd.1.md                             |  2 +-
 docs/man/ctr.1.md                                    |  2 +-
 5 files changed, 13 insertions(+), 13 deletions(-)
 rename docs/man/{config.toml.5.md => containerd-config.toml.5.md} (90%)

diff --git a/Makefile b/Makefile
index 3c9378254a3c..a474ace45cee 100644
--- a/Makefile
+++ b/Makefile
@@ -72,7 +72,7 @@ TEST_REQUIRES_ROOT_PACKAGES=$(filter \
 
 # Project binaries.
 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.
 BUILDTAGS ?= seccomp apparmor
diff --git a/docs/man/containerd-config.1.md b/docs/man/containerd-config.1.md
index 002034478d3e..8960b0a8b637 100644
--- a/docs/man/containerd-config.1.md
+++ b/docs/man/containerd-config.1.md
@@ -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)
diff --git a/docs/man/config.toml.5.md b/docs/man/containerd-config.toml.5.md
similarity index 90%
rename from docs/man/config.toml.5.md
rename to docs/man/containerd-config.toml.5.md
index 75586e813c3a..b9c1edbde329 100644
--- a/docs/man/config.toml.5.md
+++ b/docs/man/containerd-config.toml.5.md
@@ -1,13 +1,13 @@
-# config.toml 5 02/02/2018
+# /etc/containerd/config.toml 5 08/08/2018
 
 ## SYNOPSIS
 
 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**
-option of **containerd** to be used by the daemon. If the file does not exist
-at the appropriate location or is not provided via the **--config** option
-containerd uses its default configuration settings, which can be displayed
-with the **containerd config(1)** command.
+file must be placed at **/etc/containerd/config.toml** or specified with the
+**--config** option of **containerd** to be used by the daemon. If the file
+does not exist at the appropriate location or is not provided via the
+**--config** option containerd uses its default configuration settings, which
+can be displayed with the **containerd config(1)** command.
 
 ## DESCRIPTION
 
diff --git a/docs/man/containerd.1.md b/docs/man/containerd.1.md
index b919d3da6ae5..691c909eb5c1 100644
--- a/docs/man/containerd.1.md
+++ b/docs/man/containerd.1.md
@@ -53,4 +53,4 @@ Phil Estes <estesp@gmail.com>
 
 ## SEE ALSO
 
-ctr(1), config.toml(5), containerd-config(1)
+ctr(1), containerd-config(1), containerd-config.toml(5)
diff --git a/docs/man/ctr.1.md b/docs/man/ctr.1.md
index e69d535fd0a0..1febde5b4439 100644
--- a/docs/man/ctr.1.md
+++ b/docs/man/ctr.1.md
@@ -91,4 +91,4 @@ Phil Estes <estesp@gmail.com>
 
 ## SEE ALSO
 
-containerd(1), config.toml(5), containerd-config(1)
+containerd(1), containerd-config(1), containerd-config.toml(5)
-- 
2.18.0

Places

File 0001-docs-man-rename-config.toml-5-to-be-more-descriptive.patch of Package containerd.9604

Places