containerd/cmd/gen-manpages/main.go
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

71 lines
1.7 KiB
Go

/*
Copyright The containerd Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package main
import (
"flag"
"fmt"
"io/ioutil"
"os"
"path/filepath"
"strings"
"github.com/containerd/containerd/cmd/containerd/command"
"github.com/containerd/containerd/cmd/ctr/app"
"github.com/urfave/cli"
)
func main() {
if err := run(); err != nil {
fmt.Fprint(os.Stderr, err)
os.Exit(1)
}
}
func run() error {
flag.Parse()
apps := map[string]*cli.App{
"containerd": command.App(),
"ctr": app.New(),
}
dir := flag.Arg(1)
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)
}
// clear out the usage as we use banners that do not display in man pages
appName.Usage = ""
appName.ToMan()
data, err := appName.ToMan()
if err != nil {
return err
}
_ = 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
}