From a303f0b6764027eea2b21fa3a52d98569e3df64f Mon Sep 17 00:00:00 2001 From: Daniel Nephin Date: Thu, 9 Jun 2016 11:33:28 -0400 Subject: [PATCH] Add a script to generate man pages from cobra commands. Use the generate.sh script instead of md2man directly. Update Dockerfile for generating man pages. Signed-off-by: Daniel Nephin Upstream-commit: 6f66e15f990c58c46efaf73754ae94675e49b6dc Component: cli --- components/cli/cobraadaptor/adaptor.go | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/components/cli/cobraadaptor/adaptor.go b/components/cli/cobraadaptor/adaptor.go index f63307cb8b..f2c64c9f47 100644 --- a/components/cli/cobraadaptor/adaptor.go +++ b/components/cli/cobraadaptor/adaptor.go @@ -33,6 +33,7 @@ func NewCobraAdaptor(clientFlags *cliflags.ClientFlags) CobraAdaptor { var rootCmd = &cobra.Command{ Use: "docker [OPTIONS]", + Short: "A self-sufficient runtime for containers", SilenceUsage: true, SilenceErrors: true, } @@ -131,9 +132,15 @@ func (c CobraAdaptor) Command(name string) func(...string) error { return nil } +// GetRootCommand returns the root command. Required to generate the man pages +// and reference docs from a script outside this package. +func (c CobraAdaptor) GetRootCommand() *cobra.Command { + return c.rootCmd +} + var usageTemplate = `Usage: {{if not .HasSubCommands}}{{.UseLine}}{{end}}{{if .HasSubCommands}}{{ .CommandPath}} COMMAND{{end}} -{{with or .Long .Short }}{{. | trim}}{{end}}{{if gt .Aliases 0}} +{{ .Short | trim }}{{if gt .Aliases 0}} Aliases: {{.NameAndAliases}}{{end}}{{if .HasExample}}