From 4f9c4863088d6b171aaa0a20f79cc9c4349a40b4 Mon Sep 17 00:00:00 2001 From: hurf Date: Mon, 6 Jul 2015 19:36:06 +0800 Subject: [PATCH] Fix hits in help strings of kubectl get command Removed duplicated 'nodes (no)', added 'secret' for resource type. Use actual long resource name to avoid confusion. --- docs/man/man1/kubectl-describe.1 | 8 ++++---- docs/man/man1/kubectl-get.1 | 8 ++++---- docs/user-guide/kubectl/kubectl_describe.md | 10 +++++----- docs/user-guide/kubectl/kubectl_get.md | 10 +++++----- pkg/kubectl/cmd/describe.go | 8 ++++---- pkg/kubectl/cmd/get.go | 8 ++++---- 6 files changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/man/man1/kubectl-describe.1 b/docs/man/man1/kubectl-describe.1 index faaa2cf58f..708a03e369 100644 --- a/docs/man/man1/kubectl-describe.1 +++ b/docs/man/man1/kubectl-describe.1 @@ -27,10 +27,10 @@ will first check for an exact match on RESOURCE and NAME\_PREFIX. If no such res exists, it will output details for every resource that has a name prefixed with NAME\_PREFIX .PP -Possible resources include pods (po), replicationcontrollers (rc), services -(svc), nodes (no), events (ev), componentstatuses (cs), limitRanges (limits), -persistentVolumes (pv), persistentVolumeClaims (pvc), resourceQuotas (quota) -or secrets. +Possible resources include (case insensitive): pods (po), services (svc), +replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), +limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), +resourcequotas (quota) or secrets. .SH OPTIONS diff --git a/docs/man/man1/kubectl-get.1 b/docs/man/man1/kubectl-get.1 index e2f48814cf..3b198285c7 100644 --- a/docs/man/man1/kubectl-get.1 +++ b/docs/man/man1/kubectl-get.1 @@ -16,10 +16,10 @@ kubectl get \- Display one or many resources Display one or many resources. .PP -Possible resources include pods (po), replication controllers (rc), services -(svc), nodes, events (ev), component statuses (cs), limit ranges (limits), -nodes (no), persistent volumes (pv), persistent volume claims (pvc) -or resource quotas (quota). +Possible resources include (case insensitive): pods (po), services (svc), +replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), +limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), +resourcequotas (quota) or secrets. .PP By specifying the output as 'template' and providing a Go template as the value diff --git a/docs/user-guide/kubectl/kubectl_describe.md b/docs/user-guide/kubectl/kubectl_describe.md index e2f8cdadb8..bec54f93c8 100644 --- a/docs/user-guide/kubectl/kubectl_describe.md +++ b/docs/user-guide/kubectl/kubectl_describe.md @@ -37,10 +37,10 @@ $ kubectl describe RESOURCE NAME_PREFIX will first check for an exact match on RESOURCE and NAME_PREFIX. If no such resource exists, it will output details for every resource that has a name prefixed with NAME_PREFIX -Possible resources include pods (po), replicationcontrollers (rc), services -(svc), nodes (no), events (ev), componentstatuses (cs), limitRanges (limits), -persistentVolumes (pv), persistentVolumeClaims (pvc), resourceQuotas (quota) -or secrets. +Possible resources include (case insensitive): pods (po), services (svc), +replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), +limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), +resourcequotas (quota) or secrets. ``` kubectl describe (RESOURCE NAME_PREFIX | RESOURCE/NAME) @@ -102,7 +102,7 @@ $ kubectl describe pods frontend ### SEE ALSO * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-07-14 08:21:33.374469932 +0000 UTC +###### Auto generated by spf13/cobra at 2015-07-15 01:43:24.778753787 +0000 UTC diff --git a/docs/user-guide/kubectl/kubectl_get.md b/docs/user-guide/kubectl/kubectl_get.md index d7296e9b8e..923227cbfb 100644 --- a/docs/user-guide/kubectl/kubectl_get.md +++ b/docs/user-guide/kubectl/kubectl_get.md @@ -29,10 +29,10 @@ Display one or many resources Display one or many resources. -Possible resources include pods (po), replication controllers (rc), services -(svc), nodes, events (ev), component statuses (cs), limit ranges (limits), -nodes (no), persistent volumes (pv), persistent volume claims (pvc) -or resource quotas (quota). +Possible resources include (case insensitive): pods (po), services (svc), +replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), +limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), +resourcequotas (quota) or secrets. By specifying the output as 'template' and providing a Go template as the value of the --template flag, you can filter the attributes of the fetched resource(s). @@ -113,7 +113,7 @@ $ kubectl get rc/web service/frontend pods/web-pod-13je7 ### SEE ALSO * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-07-14 00:11:42.955450097 +0000 UTC +###### Auto generated by spf13/cobra at 2015-07-15 01:43:24.778535128 +0000 UTC diff --git a/pkg/kubectl/cmd/describe.go b/pkg/kubectl/cmd/describe.go index d2f4f60579..b3719be938 100644 --- a/pkg/kubectl/cmd/describe.go +++ b/pkg/kubectl/cmd/describe.go @@ -42,10 +42,10 @@ $ kubectl describe RESOURCE NAME_PREFIX will first check for an exact match on RESOURCE and NAME_PREFIX. If no such resource exists, it will output details for every resource that has a name prefixed with NAME_PREFIX -Possible resources include pods (po), replicationcontrollers (rc), services -(svc), nodes (no), events (ev), componentstatuses (cs), limitRanges (limits), -persistentVolumes (pv), persistentVolumeClaims (pvc), resourceQuotas (quota) -or secrets.` +Possible resources include (case insensitive): pods (po), services (svc), +replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), +limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), +resourcequotas (quota) or secrets.` describe_example = `// Describe a node $ kubectl describe nodes kubernetes-minion-emt8.c.myproject.internal diff --git a/pkg/kubectl/cmd/get.go b/pkg/kubectl/cmd/get.go index 4762752faf..c5a67acce2 100644 --- a/pkg/kubectl/cmd/get.go +++ b/pkg/kubectl/cmd/get.go @@ -32,10 +32,10 @@ import ( const ( get_long = `Display one or many resources. -Possible resources include pods (po), replication controllers (rc), services -(svc), nodes, events (ev), component statuses (cs), limit ranges (limits), -nodes (no), persistent volumes (pv), persistent volume claims (pvc) -or resource quotas (quota). +Possible resources include (case insensitive): pods (po), services (svc), +replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), +limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), +resourcequotas (quota) or secrets. By specifying the output as 'template' and providing a Go template as the value of the --template flag, you can filter the attributes of the fetched resource(s).`