From 2c0b6931d06374b2389efefb24f0e34a2f572f34 Mon Sep 17 00:00:00 2001 From: John McBride Date: Sat, 25 Apr 2020 14:50:08 -0600 Subject: [PATCH] Man pages wont have auto gen tag when option is disabled - this addresses #741 --- doc/man_docs.go | 6 +++--- doc/man_docs_test.go | 2 ++ 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/man_docs.go b/doc/man_docs.go index 8c7fba44..b29a6778 100644 --- a/doc/man_docs.go +++ b/doc/man_docs.go @@ -105,7 +105,7 @@ func GenMan(cmd *cobra.Command, header *GenManHeader, w io.Writer) error { if header == nil { header = &GenManHeader{} } - if err := fillHeader(header, cmd.CommandPath()); err != nil { + if err := fillHeader(header, cmd.CommandPath(), cmd.DisableAutoGenTag); err != nil { return err } @@ -114,7 +114,7 @@ func GenMan(cmd *cobra.Command, header *GenManHeader, w io.Writer) error { return err } -func fillHeader(header *GenManHeader, name string) error { +func fillHeader(header *GenManHeader, name string, disableAutoGen bool) error { if header.Title == "" { header.Title = strings.ToUpper(strings.Replace(name, " ", "\\-", -1)) } @@ -133,7 +133,7 @@ func fillHeader(header *GenManHeader, name string) error { header.Date = &now } header.date = (*header.Date).Format("Jan 2006") - if header.Source == "" { + if header.Source == "" && !disableAutoGen { header.Source = "Auto generated by spf13/cobra" } return nil diff --git a/doc/man_docs_test.go b/doc/man_docs_test.go index 2c400f5d..ee9b8753 100644 --- a/doc/man_docs_test.go +++ b/doc/man_docs_test.go @@ -101,6 +101,8 @@ func TestGenManNoGenTag(t *testing.T) { unexpected := translate("#HISTORY") checkStringOmits(t, output, unexpected) + unexpected = translate("Auto generated by spf13/cobra") + checkStringOmits(t, output, unexpected) } func TestGenManSeeAlso(t *testing.T) {