1// Copyright 2015 Red Hat Inc. All rights reserved. 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// http://www.apache.org/licenses/LICENSE-2.0 7// 8// Unless required by applicable law or agreed to in writing, software 9// distributed under the License is distributed on an "AS IS" BASIS, 10// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 11// See the License for the specific language governing permissions and 12// limitations under the License. 13 14package doc 15 16import ( 17 "strings" 18 19 "github.com/spf13/cobra" 20) 21 22// Test to see if we have a reason to print See Also information in docs 23// Basically this is a test for a parent commend or a subcommand which is 24// both not deprecated and not the autogenerated help command. 25func hasSeeAlso(cmd *cobra.Command) bool { 26 if cmd.HasParent() { 27 return true 28 } 29 for _, c := range cmd.Commands() { 30 if !c.IsAvailableCommand() || c.IsAdditionalHelpTopicCommand() { 31 continue 32 } 33 return true 34 } 35 return false 36} 37 38// Temporary workaround for yaml lib generating incorrect yaml with long strings 39// that do not contain \n. 40func forceMultiLine(s string) string { 41 if len(s) > 60 && !strings.Contains(s, "\n") { 42 s = s + "\n" 43 } 44 return s 45} 46 47type byName []*cobra.Command 48 49func (s byName) Len() int { return len(s) } 50func (s byName) Swap(i, j int) { s[i], s[j] = s[j], s[i] } 51func (s byName) Less(i, j int) bool { return s[i].Name() < s[j].Name() } 52