From f3673b8f31b68db1eaf2b6eb5230d066df1e798c Mon Sep 17 00:00:00 2001 From: feihujiang Date: Wed, 14 Oct 2015 08:34:22 +0800 Subject: [PATCH] Hide deprecated shorthand in man page --- cmd/genman/gen_kubectl_man.go | 10 +++++++--- docs/man/man1/kubectl-config-view.1 | 2 +- docs/man/man1/kubectl-convert.1 | 2 +- docs/man/man1/kubectl-expose.1 | 2 +- docs/man/man1/kubectl-get.1 | 2 +- docs/man/man1/kubectl-label.1 | 2 +- docs/man/man1/kubectl-rolling-update.1 | 2 +- docs/man/man1/kubectl-run.1 | 2 +- docs/man/man1/kubectl-version.1 | 2 +- 9 files changed, 15 insertions(+), 11 deletions(-) diff --git a/cmd/genman/gen_kubectl_man.go b/cmd/genman/gen_kubectl_man.go index a1e89af74a4..a0f85930914 100644 --- a/cmd/genman/gen_kubectl_man.go +++ b/cmd/genman/gen_kubectl_man.go @@ -78,12 +78,16 @@ func printFlags(out *bytes.Buffer, flags *pflag.FlagSet) { // put quotes on the value format = "**--%s**=%q\n\t%s\n\n" } - if len(flag.Shorthand) > 0 { + + // Todo, when we mark a shorthand is deprecated, but specify an empty message. + // The flag.ShorthandDeprecated is empty as the shorthand is deprecated. + // Using len(flag.ShorthandDeprecated) > 0 can't handle this, others are ok. + if !(len(flag.ShorthandDeprecated) > 0) && len(flag.Shorthand) > 0 { format = "**-%s**, " + format + fmt.Fprintf(out, format, flag.Shorthand, flag.Name, flag.DefValue, flag.Usage) } else { - format = "%s" + format + fmt.Fprintf(out, format, flag.Name, flag.DefValue, flag.Usage) } - fmt.Fprintf(out, format, flag.Shorthand, flag.Name, flag.DefValue, flag.Usage) }) } diff --git a/docs/man/man1/kubectl-config-view.1 b/docs/man/man1/kubectl-config-view.1 index abf2675bf3b..0cac3b0b117 100644 --- a/docs/man/man1/kubectl-config-view.1 +++ b/docs/man/man1/kubectl-config-view.1 @@ -59,7 +59,7 @@ You can use \-\-output=template \-\-template=TEMPLATE to extract specific values If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. 'ObjectMeta.Name'). The field in the API resource specified by this JSONPath expression must be an integer or a string. .PP -\fB\-t\fP, \fB\-\-template\fP="" +\fB\-\-template\fP="" Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ \[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. diff --git a/docs/man/man1/kubectl-convert.1 b/docs/man/man1/kubectl-convert.1 index 9c806b079dc..5cf7c52e34e 100644 --- a/docs/man/man1/kubectl-convert.1 +++ b/docs/man/man1/kubectl-convert.1 @@ -62,7 +62,7 @@ to change to output destination. If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. 'ObjectMeta.Name'). The field in the API resource specified by this JSONPath expression must be an integer or a string. .PP -\fB\-t\fP, \fB\-\-template\fP="" +\fB\-\-template\fP="" Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ \[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. diff --git a/docs/man/man1/kubectl-expose.1 b/docs/man/man1/kubectl-expose.1 index 840fe4eaaee..3e98f2d99ec 100644 --- a/docs/man/man1/kubectl-expose.1 +++ b/docs/man/man1/kubectl-expose.1 @@ -105,7 +105,7 @@ re\-use the labels from the resource it exposes. Name or number for the port on the container that the service should direct traffic to. Optional. .PP -\fB\-t\fP, \fB\-\-template\fP="" +\fB\-\-template\fP="" Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ \[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. diff --git a/docs/man/man1/kubectl-get.1 b/docs/man/man1/kubectl-get.1 index 2a8965284ec..f419b540897 100644 --- a/docs/man/man1/kubectl-get.1 +++ b/docs/man/man1/kubectl-get.1 @@ -66,7 +66,7 @@ of the \-\-template flag, you can filter the attributes of the fetched resource( If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. 'ObjectMeta.Name'). The field in the API resource specified by this JSONPath expression must be an integer or a string. .PP -\fB\-t\fP, \fB\-\-template\fP="" +\fB\-\-template\fP="" Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ \[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. diff --git a/docs/man/man1/kubectl-label.1 b/docs/man/man1/kubectl-label.1 index 56fadc3670a..9b831a268a7 100644 --- a/docs/man/man1/kubectl-label.1 +++ b/docs/man/man1/kubectl-label.1 @@ -69,7 +69,7 @@ If \-\-resource\-version is specified, then updates will use this resource versi If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. 'ObjectMeta.Name'). The field in the API resource specified by this JSONPath expression must be an integer or a string. .PP -\fB\-t\fP, \fB\-\-template\fP="" +\fB\-\-template\fP="" Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ \[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. diff --git a/docs/man/man1/kubectl-rolling-update.1 b/docs/man/man1/kubectl-rolling-update.1 index de5b275f807..5b95687fa7c 100644 --- a/docs/man/man1/kubectl-rolling-update.1 +++ b/docs/man/man1/kubectl-rolling-update.1 @@ -73,7 +73,7 @@ existing replication controller and overwrite at least one (common) label in its If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. 'ObjectMeta.Name'). The field in the API resource specified by this JSONPath expression must be an integer or a string. .PP -\fB\-t\fP, \fB\-\-template\fP="" +\fB\-\-template\fP="" Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ \[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. diff --git a/docs/man/man1/kubectl-run.1 b/docs/man/man1/kubectl-run.1 index 033437b3f91..e0554cf9c33 100644 --- a/docs/man/man1/kubectl-run.1 +++ b/docs/man/man1/kubectl-run.1 @@ -101,7 +101,7 @@ Creates a replication controller to manage the created container(s). Keep stdin open on the container(s) in the pod, even if nothing is attached. .PP -\fB\-t\fP, \fB\-\-template\fP="" +\fB\-\-template\fP="" Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ \[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. diff --git a/docs/man/man1/kubectl-version.1 b/docs/man/man1/kubectl-version.1 index 916c43f3858..a6f6c075622 100644 --- a/docs/man/man1/kubectl-version.1 +++ b/docs/man/man1/kubectl-version.1 @@ -18,7 +18,7 @@ Print the client and server version information. .SH OPTIONS .PP -\fB\-c\fP, \fB\-\-client\fP=false +\fB\-\-client\fP=false Client version only (no server required).