Skip to content

Commit

Permalink
Regen docs with new pflags
Browse files Browse the repository at this point in the history 
This basically just shows in the docs that the =false portion of
booleans are optional.
  • Loading branch information
@eparis
eparis committed Aug 6, 2015
1 parent 3fe85d4 commit 76896bf
Show file tree
Hide file tree
Showing 32 changed files with 198 additions and 221 deletions.
6 changes: 3 additions & 3 deletions docs/man/man1/kubectl-rolling-update.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ existing replication controller and overwrite at least one (common) label in its
Output the formatted object with the given version (default api\-version).

.PP
\fB\-\-poll\-interval\fP="3s"
\fB\-\-poll\-interval\fP=3s
Time delay between polling for replication controller status after the update. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

.PP
Expand All @@ -68,11 +68,11 @@ existing replication controller and overwrite at least one (common) label in its
\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]

.PP
\fB\-\-timeout\fP="5m0s"
\fB\-\-timeout\fP=5m0s
Max time to wait for a replication controller to update before giving up. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

.PP
\fB\-\-update\-period\fP="1m0s"
\fB\-\-update\-period\fP=1m0s
Time to wait between updating pods. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".


Expand Down
10 changes: 5 additions & 5 deletions docs/user-guide/kubectl/kubectl.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,14 @@ kubectl
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
-h, --help=false: help for kubectl
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
-h, --help[=false]: help for kubectl
--insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
--log-backtrace-at=:0: when logging hits line file:N, emit a stack trace
--log-dir=: If non-empty, write log files in this directory
--log-flush-frequency=5s: Maximum number of seconds between log flushes
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--match-server-version[=false]: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
--password="": Password for basic authentication to the API server.
-s, --server="": The address and port of the Kubernetes API server
Expand All @@ -72,7 +72,7 @@ kubectl
--user="": The name of the kubeconfig user to use
--username="": Username for basic authentication to the API server.
--v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it
--validate[=false]: If true, use a schema to validate the input before sending it
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
```

Expand Down Expand Up @@ -102,7 +102,7 @@ kubectl
* [kubectl stop](kubectl_stop.md) - Deprecated: Gracefully shut down a resource by name or filename.
* [kubectl version](kubectl_version.md) - Print the client and server version information.

###### Auto generated by spf13/cobra at 2015-08-05 08:34:34.582015569 +0000 UTC
###### Auto generated by spf13/cobra at 2015-08-05 23:27:50.891029728 +0000 UTC

<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl.md?pixel)]()
Expand Down
16 changes: 8 additions & 8 deletions docs/user-guide/kubectl/kubectl_annotate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,12 @@ $ kubectl annotate pods foo description-
### Options

```
--all=false: select all resources in the namespace of the specified resource types
-h, --help=false: help for annotate
--no-headers=false: When using the default output, don't print headers.
--all[=false]: select all resources in the namespace of the specified resource types
-h, --help[=false]: help for annotate
--no-headers[=false]: When using the default output, don't print headers.
-o, --output="": Output format. One of: json|yaml|template|templatefile|wide.
--output-version="": Output the formatted object with the given version (default api-version).
--overwrite=false: If true, allow annotations to be overwritten, otherwise reject annotation updates that overwrite existing annotations.
--overwrite[=false]: If true, allow annotations to be overwritten, otherwise reject annotation updates that overwrite existing annotations.
--resource-version="": If non-empty, the annotation update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource.
-t, --template="": Template string or path to template file to use when -o=template or -o=templatefile. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]
```
Expand All @@ -98,13 +98,13 @@ $ kubectl annotate pods foo description-
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
--log-backtrace-at=:0: when logging hits line file:N, emit a stack trace
--log-dir=: If non-empty, write log files in this directory
--log-flush-frequency=5s: Maximum number of seconds between log flushes
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--match-server-version[=false]: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
--password="": Password for basic authentication to the API server.
-s, --server="": The address and port of the Kubernetes API server
Expand All @@ -113,15 +113,15 @@ $ kubectl annotate pods foo description-
--user="": The name of the kubeconfig user to use
--username="": Username for basic authentication to the API server.
--v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it
--validate[=false]: If true, use a schema to validate the input before sending it
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
```

### SEE ALSO

* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager

###### Auto generated by spf13/cobra at 2015-08-03 21:33:00.41118358 +0000 UTC
###### Auto generated by spf13/cobra at 2015-08-05 14:22:30.875870257 +0000 UTC

<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_annotate.md?pixel)]()
Expand Down
11 changes: 5 additions & 6 deletions docs/user-guide/kubectl/kubectl_api-versions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ kubectl api-versions
### Options

```
-h, --help=false: help for api-versions
-h, --help[=false]: help for api-versions
```

### Options inherited from parent commands
Expand All @@ -60,13 +60,13 @@ kubectl api-versions
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
--log-backtrace-at=:0: when logging hits line file:N, emit a stack trace
--log-dir=: If non-empty, write log files in this directory
--log-flush-frequency=5s: Maximum number of seconds between log flushes
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--match-server-version[=false]: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
--password="": Password for basic authentication to the API server.
-s, --server="": The address and port of the Kubernetes API server
Expand All @@ -75,16 +75,15 @@ kubectl api-versions
--user="": The name of the kubeconfig user to use
--username="": Username for basic authentication to the API server.
--v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it
--validate[=false]: If true, use a schema to validate the input before sending it
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
```

### SEE ALSO

* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager

###### Auto generated by spf13/cobra at 2015-07-29 09:00:08.946374303 +0000 UTC

###### Auto generated by spf13/cobra at 2015-08-05 23:27:50.890645232 +0000 UTC

<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_api-versions.md?pixel)]()
Expand Down
15 changes: 7 additions & 8 deletions docs/user-guide/kubectl/kubectl_attach.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ $ kubectl attach 123456-7890 -c ruby-container -i -t

```
-c, --container="": Container name
-h, --help=false: help for attach
-i, --stdin=false: Pass stdin to the container
-t, --tty=false: Stdin is a TTY
-h, --help[=false]: help for attach
-i, --stdin[=false]: Pass stdin to the container
-t, --tty[=false]: Stdin is a TTY
```

### Options inherited from parent commands
Expand All @@ -77,13 +77,13 @@ $ kubectl attach 123456-7890 -c ruby-container -i -t
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
--log-backtrace-at=:0: when logging hits line file:N, emit a stack trace
--log-dir=: If non-empty, write log files in this directory
--log-flush-frequency=5s: Maximum number of seconds between log flushes
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--match-server-version[=false]: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
--password="": Password for basic authentication to the API server.
-s, --server="": The address and port of the Kubernetes API server
Expand All @@ -92,16 +92,15 @@ $ kubectl attach 123456-7890 -c ruby-container -i -t
--user="": The name of the kubeconfig user to use
--username="": Username for basic authentication to the API server.
--v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it
--validate[=false]: If true, use a schema to validate the input before sending it
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
```

### SEE ALSO

* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager

###### Auto generated by spf13/cobra at 2015-07-30 17:45:25.860905122 +0000 UTC

###### Auto generated by spf13/cobra at 2015-08-05 14:22:30.874171127 +0000 UTC

<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_attach.md?pixel)]()
Expand Down
11 changes: 5 additions & 6 deletions docs/user-guide/kubectl/kubectl_cluster-info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ kubectl cluster-info
### Options

```
-h, --help=false: help for cluster-info
-h, --help[=false]: help for cluster-info
```

### Options inherited from parent commands
Expand All @@ -60,13 +60,13 @@ kubectl cluster-info
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
--log-backtrace-at=:0: when logging hits line file:N, emit a stack trace
--log-dir=: If non-empty, write log files in this directory
--log-flush-frequency=5s: Maximum number of seconds between log flushes
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--match-server-version[=false]: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
--password="": Password for basic authentication to the API server.
-s, --server="": The address and port of the Kubernetes API server
Expand All @@ -75,16 +75,15 @@ kubectl cluster-info
--user="": The name of the kubeconfig user to use
--username="": Username for basic authentication to the API server.
--v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it
--validate[=false]: If true, use a schema to validate the input before sending it
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
```

### SEE ALSO

* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager

###### Auto generated by spf13/cobra at 2015-07-14 00:11:42.959601452 +0000 UTC

###### Auto generated by spf13/cobra at 2015-08-05 14:22:30.877534441 +0000 UTC

<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_cluster-info.md?pixel)]()
Expand Down
11 changes: 5 additions & 6 deletions docs/user-guide/kubectl/kubectl_config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ kubectl config SUBCOMMAND
### Options

```
-h, --help=false: help for config
-h, --help[=false]: help for config
--kubeconfig="": use a particular kubeconfig file
```

Expand All @@ -67,12 +67,12 @@ kubectl config SUBCOMMAND
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--log-backtrace-at=:0: when logging hits line file:N, emit a stack trace
--log-dir=: If non-empty, write log files in this directory
--log-flush-frequency=5s: Maximum number of seconds between log flushes
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--match-server-version[=false]: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
--password="": Password for basic authentication to the API server.
-s, --server="": The address and port of the Kubernetes API server
Expand All @@ -81,7 +81,7 @@ kubectl config SUBCOMMAND
--user="": The name of the kubeconfig user to use
--username="": Username for basic authentication to the API server.
--v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it
--validate[=false]: If true, use a schema to validate the input before sending it
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
```

Expand All @@ -96,8 +96,7 @@ kubectl config SUBCOMMAND
* [kubectl config use-context](kubectl_config_use-context.md) - Sets the current-context in a kubeconfig file
* [kubectl config view](kubectl_config_view.md) - displays Merged kubeconfig settings or a specified kubeconfig file.

###### Auto generated by spf13/cobra at 2015-07-14 00:11:42.959458886 +0000 UTC

###### Auto generated by spf13/cobra at 2015-08-05 14:22:30.877353612 +0000 UTC

<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config.md?pixel)]()
Expand Down
9 changes: 4 additions & 5 deletions docs/user-guide/kubectl/kubectl_config_set-cluster.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ $ kubectl config set-cluster e2e --insecure-skip-tls-verify=true
--api-version=: api-version for the cluster entry in kubeconfig
--certificate-authority=: path to certificate-authority for the cluster entry in kubeconfig
--embed-certs=false: embed-certs for the cluster entry in kubeconfig
-h, --help=false: help for set-cluster
-h, --help[=false]: help for set-cluster
--insecure-skip-tls-verify=false: insecure-skip-tls-verify for the cluster entry in kubeconfig
--server=: server for the cluster entry in kubeconfig
```
Expand All @@ -82,24 +82,23 @@ $ kubectl config set-cluster e2e --insecure-skip-tls-verify=true
--log-dir=: If non-empty, write log files in this directory
--log-flush-frequency=5s: Maximum number of seconds between log flushes
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--match-server-version[=false]: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
--password="": Password for basic authentication to the API server.
--stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use
--username="": Username for basic authentication to the API server.
--v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it
--validate[=false]: If true, use a schema to validate the input before sending it
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
```

### SEE ALSO

* [kubectl config](kubectl_config.md) - config modifies kubeconfig files

###### Auto generated by spf13/cobra at 2015-07-14 00:11:42.95861887 +0000 UTC

###### Auto generated by spf13/cobra at 2015-08-05 14:22:30.87626611 +0000 UTC

<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_set-cluster.md?pixel)]()
Expand Down
Loading

0 comments on commit 76896bf

Please sign in to comment.