man: move ctr.1, containerd-config to section 8, and fix generation

thaJeztah · thaJeztah · commit ad090e67e9d7 · 2020-04-03T12:32:52.000+02:00
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 &lt;github@gone.nl&gt;
diff --git a/Makefile b/Makefile
@@ -88,7 +88,7 @@ endif
 
 # Project binaries.
 COMMANDS=ctr containerd containerd-stress
-MANPAGES=ctr.1 containerd.8 containerd-config.1 containerd-config.toml.5
+MANPAGES=ctr.8 containerd.8 containerd-config.8 containerd-config.toml.5
 
 ifdef BUILDTAGS
     GO_BUILDTAGS = ${BUILDTAGS}
@@ -214,15 +214,15 @@ mandir:
 	@mkdir -p man
 
 # Kept for backwards compatability
-genman: man/containerd.8 man/ctr.1
+genman: man/containerd.8 man/ctr.8
 
 man/containerd.8: FORCE
 	@echo "$(WHALE) $@"
-	go run cmd/gen-manpages/main.go containerd man/
+	go run cmd/gen-manpages/main.go $(@F) $(@D)
 
-man/ctr.1: FORCE
+man/ctr.8: FORCE
 	@echo "$(WHALE) $@"
-	go run cmd/gen-manpages/main.go ctr man/
+	go run cmd/gen-manpages/main.go $(@F) $(@D)
 
 man/%: docs/man/%.md FORCE
 	@echo "$(WHALE) $@"
diff --git a/cmd/gen-manpages/main.go b/cmd/gen-manpages/main.go
@@ -22,6 +22,7 @@ import (
 	"io/ioutil"
 	"os"
 	"path/filepath"
+	"strings"
 
 	"github.com/containerd/containerd/cmd/containerd/command"
 	"github.com/containerd/containerd/cmd/ctr/app"
@@ -41,22 +42,28 @@ func run() error {
 		"containerd": command.App(),
 		"ctr":        app.New(),
 	}
-	name := flag.Arg(0)
 	dir := flag.Arg(1)
-	app, ok := apps[name]
+
+	parts := strings.SplitN(flag.Arg(0), ".", 2)
+	if len(parts) != 2 {
+		return fmt.Errorf("invalid name '%s': name does not contain man page section", flag.Arg(0))
+	}
+	name, section := parts[0], parts[1]
+
+	appName, ok := apps[name]
 	if !ok {
-		return fmt.Errorf("Invalid application '%s'", name)
+		return fmt.Errorf("invalid application '%s'", name)
 	}
+
 	// clear out the usage as we use banners that do not display in man pages
-	app.Usage = ""
-	data, err := app.ToMan()
+	appName.Usage = ""
+	appName.ToMan()
+	data, err := appName.ToMan()
 	if err != nil {
 		return err
 	}
-	if _, err := os.Stat(dir); os.IsNotExist(err) {
-		os.Mkdir(dir, os.ModePerm)
-	}
-	if err := ioutil.WriteFile(filepath.Join(dir, fmt.Sprintf("%s.1", name)), []byte(data), 0644); err != nil {
+	_ = os.MkdirAll(dir, os.ModePerm)
+	if err := ioutil.WriteFile(filepath.Join(dir, fmt.Sprintf("%s.%s", name, section)), []byte(data), 0644); err != nil {
 		return err
 	}
 	return nil
diff --git a/docs/man/containerd-config.8.md b/docs/man/containerd-config.8.md
@@ -1,4 +1,4 @@
-# containerd-config 1 01/30/2018
+# containerd-config 8 01/30/2018
 
 ## NAME
 
@@ -38,4 +38,4 @@ Phil Estes <estesp@gmail.com>
 
 ## SEE ALSO
 
-ctr(1), containerd(8), containerd-config.toml(5)
+ctr(8), containerd(8), containerd-config.toml(5)
diff --git a/docs/man/containerd-config.toml.5.md b/docs/man/containerd-config.toml.5.md
@@ -142,4 +142,4 @@ Phil Estes <estesp@gmail.com>
 
 ## SEE ALSO
 
-ctr(1), containerd-config(1), containerd(8)
+ctr(8), containerd-config(8), containerd(8)

Original file line number	Diff line number	Diff line change
`@@ -142,4 +142,4 @@ Phil Estes <estesp@gmail.com>`
`142`	`142`
`143`	`143`	`## SEE ALSO`
`144`	`144`
`145`		`-ctr(1), containerd-config(1), containerd(8)`
	`145`	`+ctr(8), containerd-config(8), containerd(8)`