github.phpd.cn/cilium/cilium@v1.6.12/daemon/cmdref.go (about)

     1  // Copyright 2016-2018 Authors of Cilium
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package main
    16  
    17  import (
    18  	"fmt"
    19  	"os"
    20  	"strings"
    21  
    22  	"github.com/cilium/cilium/pkg/option"
    23  
    24  	"github.com/spf13/cobra"
    25  	"github.com/spf13/cobra/doc"
    26  )
    27  
    28  func genMarkdown(cmd *cobra.Command) {
    29  	// Remove the line 'Auto generated by spf13/cobra on ...'
    30  	cmd.DisableAutoGenTag = true
    31  	if err := doc.GenMarkdownTreeCustom(cmd, option.Config.CMDRefDir, filePrepend, linkHandler); err != nil {
    32  		log.Fatal(err)
    33  	}
    34  	os.Exit(0)
    35  }
    36  
    37  func linkHandler(s string) string {
    38  	// The generated files have a 'See also' section but the URL's are
    39  	// hardcoded to use Markdown but we only want / have them in HTML
    40  	// later.
    41  	return strings.Replace(s, ".md", ".html", 1)
    42  }
    43  
    44  func filePrepend(s string) string {
    45  	// Prepend a HTML comment that this file is autogenerated. So that
    46  	// users are warned before fixing issues in the Markdown files.  Should
    47  	// never show up on the web.
    48  	return fmt.Sprintf("%s\n\n", "<!-- This file was autogenerated via cilium-agent --cmdref, do not edit manually-->")
    49  }