1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
// Copyright 2016 cli-docs-tool 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 clidocstool
import (
"fmt"
"log"
"os"
"strconv"
"time"
"github.com/spf13/cobra"
"github.com/spf13/cobra/doc"
)
// GenManTree generates a man page for the command and all descendants.
// If SOURCE_DATE_EPOCH is set, in order to allow reproducible package
// builds, we explicitly set the build time to SOURCE_DATE_EPOCH.
func (c *Client) GenManTree(cmd *cobra.Command) error {
if err := c.loadLongDescription(cmd, "man"); err != nil {
return err
}
if epoch := os.Getenv("SOURCE_DATE_EPOCH"); c.manHeader != nil && epoch != "" {
unixEpoch, err := strconv.ParseInt(epoch, 10, 64)
if err != nil {
return fmt.Errorf("invalid SOURCE_DATE_EPOCH: %v", err)
}
now := time.Unix(unixEpoch, 0)
c.manHeader.Date = &now
}
return c.genManTreeCustom(cmd)
}
func (c *Client) genManTreeCustom(cmd *cobra.Command) error {
for _, sc := range cmd.Commands() {
if err := c.genManTreeCustom(sc); err != nil {
return err
}
}
// always disable the addition of [flags] to the usage
cmd.DisableFlagsInUseLine = true
// always disable "spf13/cobra" auto gen tag
cmd.DisableAutoGenTag = true
// Skip the root command altogether, to prevent generating a useless
// md file for plugins.
if c.plugin && !cmd.HasParent() {
return nil
}
log.Printf("INFO: Generating Man for %q", cmd.CommandPath())
return doc.GenManTreeFromOpts(cmd, doc.GenManTreeOptions{
Header: c.manHeader,
Path: c.target,
CommandSeparator: "-",
})
}
|
