forked from cilium/cilium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cmdref.go
62 lines (54 loc) · 1.84 KB
/
cmdref.go
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
// Copyright 2018-2019 Authors of Cilium
//
// 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 cmd
import (
"fmt"
"os"
"strings"
"github.com/spf13/cobra"
"github.com/spf13/cobra/doc"
)
var cmdRefDir string
var cmdRef = &cobra.Command{
Use: "cmdref",
Short: "Generate Cilium command reference",
Run: func(cmd *cobra.Command, args []string) {
genCmdRef()
},
Hidden: true,
}
func genCmdRef() {
// Remove the line 'Auto generated by spf13/cobra on ...'
BugtoolRootCmd.DisableAutoGenTag = true
if err := doc.GenMarkdownTreeCustom(BugtoolRootCmd, cmdRefDir, filePrepend, linkHandler); err != nil {
fmt.Fprintf(os.Stderr, "%s\n", err.Error())
return
}
}
func linkHandler(s string) string {
// The generated files have a 'See also' section but the URL's are
// hardcoded to use Markdown but we only want / have them in HTML
// later.
return strings.Replace(s, ".md", ".html", 1)
}
func filePrepend(s string) string {
// Prepend a HTML comment that this file is autogenerated. So that
// users are warned before fixing issues in the Markdown files. Should
// never show up on the web.
return fmt.Sprintf("%s\n\n", "<!-- This file was autogenerated via cilium cmdref, do not edit manually-->")
}
func init() {
cmdRef.Flags().StringVarP(&cmdRefDir, "directory", "d", "./", "Path to the output directory")
BugtoolRootCmd.AddCommand(cmdRef)
}