Skip to content

Commit

Permalink
rebase
Browse files Browse the repository at this point in the history
lowercase and clear

update doc

update
  • Loading branch information
guangxuli committed Dec 14, 2016
1 parent 41702ed commit 34069ee
Show file tree
Hide file tree
Showing 147 changed files with 340 additions and 340 deletions.
2 changes: 1 addition & 1 deletion docs/man/man1/oadm-build-chain.1
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Supported formats for the generated graph are dot and a human\-readable output.
.SH OPTIONS
.PP
\fB\-\-all\fP=false
Build dependency tree for the specified image stream tag across all namespaces
If true, build dependency tree for the specified image stream tag across all namespaces

.PP
\fB\-o\fP, \fB\-\-output\fP=""
Expand Down
6 changes: 3 additions & 3 deletions docs/man/man1/oadm-diagnostics.1
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,15 @@ The available diagnostic names are: AggregatedLogging, AnalyzeLogs, ClusterRegis

.PP
\fB\-\-host\fP=false
Look for systemd and journald units even without master/node config
If true, look for systemd and journald units even without master/node config

.PP
\fB\-\-images\fP="openshift/origin\-${component}:${version}"
Image template for DiagnosticPod to use in creating a pod

.PP
\fB\-\-latest\-images\fP=false
When expanding the image template, use latest version, not release version
If true, when expanding the image template, use latest version, not release version

.PP
\fB\-\-loglevel\fP=0
Expand All @@ -95,7 +95,7 @@ The available diagnostic names are: AggregatedLogging, AnalyzeLogs, ClusterRegis

.PP
\fB\-\-prevent\-modification\fP=false
May be set to prevent diagnostics making any changes via the API
If true, may be set to prevent diagnostics making any changes via the API


.SH OPTIONS INHERITED FROM PARENT COMMANDS
Expand Down
2 changes: 1 addition & 1 deletion docs/man/man1/oadm-ipfailover.1
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ If an IP failover configuration does not exist with the given name, the \-\-crea
.SH OPTIONS
.PP
\fB\-\-create\fP=false
Create the configuration if it does not exist.
If true, create the configuration if it does not exist.

.PP
\fB\-\-credentials\fP=""
Expand Down
4 changes: 2 additions & 2 deletions docs/man/man1/oadm-policy-reconcile-cluster-role-bindings.1
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ You can see which recommended cluster role bindings have changed by choosing an
.SH OPTIONS
.PP
\fB\-\-additive\-only\fP=true
Preserves extra subjects in cluster role bindings.
If true, preserves extra subjects in cluster role bindings.

.PP
\fB\-\-confirm\fP=false
Specify that cluster role bindings should be modified. Defaults to false, displaying what would be replaced but not actually replacing anything.
If true, specify that cluster role bindings should be modified. Defaults to false, displaying what would be replaced but not actually replacing anything.

.PP
\fB\-\-exclude\-groups\fP=[]
Expand Down
4 changes: 2 additions & 2 deletions docs/man/man1/oadm-policy-reconcile-cluster-roles.1
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ You can see which cluster roles have recommended changed by choosing an output t
.SH OPTIONS
.PP
\fB\-\-additive\-only\fP=true
Preserves modified cluster roles.
If true, preserves modified cluster roles.

.PP
\fB\-\-confirm\fP=false
Specify that cluster roles should be modified. Defaults to false, displaying what would be replaced but not actually replacing anything.
If true, specify that cluster roles should be modified. Defaults to false, displaying what would be replaced but not actually replacing anything.

.PP
\fB\-\-no\-headers\fP=false
Expand Down
4 changes: 2 additions & 2 deletions docs/man/man1/oadm-policy-reconcile-sccs.1
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ You can see which cluster SCCs have recommended changes by choosing an output ty
.SH OPTIONS
.PP
\fB\-\-additive\-only\fP=true
Preserves extra users, groups, labels and annotations in the SCC as well as existing priorities.
If true, preserves extra users, groups, labels and annotations in the SCC as well as existing priorities.

.PP
\fB\-\-confirm\fP=false
Specify that cluster SCCs should be modified. Defaults to false, displaying what would be replaced but not actually replacing anything.
If true, specify that cluster SCCs should be modified. Defaults to false, displaying what would be replaced but not actually replacing anything.

.PP
\fB\-\-infrastructure\-namespace\fP="openshift\-infra"
Expand Down
2 changes: 1 addition & 1 deletion docs/man/man1/oadm-policy-who-can.1
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ List who can perform the specified action on a resource
.SH OPTIONS
.PP
\fB\-\-all\-namespaces\fP=false
If present, list who can perform the specified action in all namespaces.
If true, list who can perform the specified action in all namespaces.


.SH OPTIONS INHERITED FROM PARENT COMMANDS
Expand Down
4 changes: 2 additions & 2 deletions docs/man/man1/oadm-prune-builds.1
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ By default, the prune operation performs a dry run making no changes to internal
.SH OPTIONS
.PP
\fB\-\-confirm\fP=false
Specify that build pruning should proceed. Defaults to false, displaying what would be deleted but not actually deleting anything.
If true, specify that build pruning should proceed. Defaults to false, displaying what would be deleted but not actually deleting anything.

.PP
\fB\-\-keep\-complete\fP=5
Expand All @@ -38,7 +38,7 @@ By default, the prune operation performs a dry run making no changes to internal

.PP
\fB\-\-orphans\fP=false
Prune all builds whose associated BuildConfig no longer exists and whose status is complete, failed, error, or cancelled.
If true, prune all builds whose associated BuildConfig no longer exists and whose status is complete, failed, error, or cancelled.


.SH OPTIONS INHERITED FROM PARENT COMMANDS
Expand Down
4 changes: 2 additions & 2 deletions docs/man/man1/oadm-prune-deployments.1
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ By default, the prune operation performs a dry run making no changes to the depl
.SH OPTIONS
.PP
\fB\-\-confirm\fP=false
Specify that deployment pruning should proceed. Defaults to false, displaying what would be deleted but not actually deleting anything.
If true, specify that deployment pruning should proceed. Defaults to false, displaying what would be deleted but not actually deleting anything.

.PP
\fB\-\-keep\-complete\fP=5
Expand All @@ -38,7 +38,7 @@ By default, the prune operation performs a dry run making no changes to the depl

.PP
\fB\-\-orphans\fP=false
Prune all deployments where the associated DeploymentConfig no longer exists, the status is complete or failed, and the replica size is 0.
If true, prune all deployments where the associated DeploymentConfig no longer exists, the status is complete or failed, and the replica size is 0.


.SH OPTIONS INHERITED FROM PARENT COMMANDS
Expand Down
2 changes: 1 addition & 1 deletion docs/man/man1/oadm-prune-images.1
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Only a user with a cluster role system:image\-pruner or higher who is logged\-in

.PP
\fB\-\-confirm\fP=false
Specify that image pruning should proceed. Defaults to false, displaying what would be deleted but not actually deleting anything.
If true, specify that image pruning should proceed. Defaults to false, displaying what would be deleted but not actually deleting anything.

.PP
\fB\-\-keep\-tag\-revisions\fP=3
Expand Down
4 changes: 2 additions & 2 deletions docs/man/man1/oadm-registry.1
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,15 @@ NOTE: This command is intended to simplify the tasks of setting up a Docker regi

.PP
\fB\-\-daemonset\fP=false
Use a daemonset instead of a deployment config.
If true, use a daemonset instead of a deployment config.

.PP
\fB\-\-dry\-run\fP=false
If true, show the result of the operation without performing it.

.PP
\fB\-\-enforce\-quota\fP=false
If set, the registry will refuse to write blobs if they exceed quota limits
If true, the registry will refuse to write blobs if they exceed quota limits

.PP
\fB\-\-images\fP="openshift/origin\-${component}:${version}"
Expand Down
4 changes: 2 additions & 2 deletions docs/man/man1/oadm-router.1
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ If a router does not exist with the given name, this command will create a deplo

.PP
\fB\-\-expose\-metrics\fP=false
This is a hint to run an extra container in the pod to expose metrics \- the image will either be set depending on the router implementation or provided with \-\-metrics\-image.
If true, attempts to run an extra container in the pod to expose metrics \- the image will either be set depending on the router implementation or provided with \-\-metrics\-image.

.PP
\fB\-\-external\-host\fP=""
Expand Down Expand Up @@ -129,7 +129,7 @@ If a router does not exist with the given name, this command will create a deplo

.PP
\fB\-\-secrets\-as\-env\fP=false
Use environment variables for master secrets.
If true, use environment variables for master secrets.

.PP
\fB\-\-selector\fP=""
Expand Down
2 changes: 1 addition & 1 deletion docs/man/man1/oc-adm-build-chain.1
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Supported formats for the generated graph are dot and a human\-readable output.
.SH OPTIONS
.PP
\fB\-\-all\fP=false
Build dependency tree for the specified image stream tag across all namespaces
If true, build dependency tree for the specified image stream tag across all namespaces

.PP
\fB\-o\fP, \fB\-\-output\fP=""
Expand Down
6 changes: 3 additions & 3 deletions docs/man/man1/oc-adm-diagnostics.1
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,15 @@ The available diagnostic names are: AggregatedLogging, AnalyzeLogs, ClusterRegis

.PP
\fB\-\-host\fP=false
Look for systemd and journald units even without master/node config
If true, look for systemd and journald units even without master/node config

.PP
\fB\-\-images\fP="openshift/origin\-${component}:${version}"
Image template for DiagnosticPod to use in creating a pod

.PP
\fB\-\-latest\-images\fP=false
When expanding the image template, use latest version, not release version
If true, when expanding the image template, use latest version, not release version

.PP
\fB\-\-loglevel\fP=0
Expand All @@ -95,7 +95,7 @@ The available diagnostic names are: AggregatedLogging, AnalyzeLogs, ClusterRegis

.PP
\fB\-\-prevent\-modification\fP=false
May be set to prevent diagnostics making any changes via the API
If true, may be set to prevent diagnostics making any changes via the API


.SH OPTIONS INHERITED FROM PARENT COMMANDS
Expand Down
2 changes: 1 addition & 1 deletion docs/man/man1/oc-adm-ipfailover.1
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ If an IP failover configuration does not exist with the given name, the \-\-crea
.SH OPTIONS
.PP
\fB\-\-create\fP=false
Create the configuration if it does not exist.
If true, create the configuration if it does not exist.

.PP
\fB\-\-credentials\fP=""
Expand Down
4 changes: 2 additions & 2 deletions docs/man/man1/oc-adm-policy-reconcile-cluster-role-bindings.1
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ You can see which recommended cluster role bindings have changed by choosing an
.SH OPTIONS
.PP
\fB\-\-additive\-only\fP=true
Preserves extra subjects in cluster role bindings.
If true, preserves extra subjects in cluster role bindings.

.PP
\fB\-\-confirm\fP=false
Specify that cluster role bindings should be modified. Defaults to false, displaying what would be replaced but not actually replacing anything.
If true, specify that cluster role bindings should be modified. Defaults to false, displaying what would be replaced but not actually replacing anything.

.PP
\fB\-\-exclude\-groups\fP=[]
Expand Down
4 changes: 2 additions & 2 deletions docs/man/man1/oc-adm-policy-reconcile-cluster-roles.1
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ You can see which cluster roles have recommended changed by choosing an output t
.SH OPTIONS
.PP
\fB\-\-additive\-only\fP=true
Preserves modified cluster roles.
If true, preserves modified cluster roles.

.PP
\fB\-\-confirm\fP=false
Specify that cluster roles should be modified. Defaults to false, displaying what would be replaced but not actually replacing anything.
If true, specify that cluster roles should be modified. Defaults to false, displaying what would be replaced but not actually replacing anything.

.PP
\fB\-\-no\-headers\fP=false
Expand Down
4 changes: 2 additions & 2 deletions docs/man/man1/oc-adm-policy-reconcile-sccs.1
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ You can see which cluster SCCs have recommended changes by choosing an output ty
.SH OPTIONS
.PP
\fB\-\-additive\-only\fP=true
Preserves extra users, groups, labels and annotations in the SCC as well as existing priorities.
If true, preserves extra users, groups, labels and annotations in the SCC as well as existing priorities.

.PP
\fB\-\-confirm\fP=false
Specify that cluster SCCs should be modified. Defaults to false, displaying what would be replaced but not actually replacing anything.
If true, specify that cluster SCCs should be modified. Defaults to false, displaying what would be replaced but not actually replacing anything.

.PP
\fB\-\-infrastructure\-namespace\fP="openshift\-infra"
Expand Down
2 changes: 1 addition & 1 deletion docs/man/man1/oc-adm-policy-who-can.1
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ List who can perform the specified action on a resource
.SH OPTIONS
.PP
\fB\-\-all\-namespaces\fP=false
If present, list who can perform the specified action in all namespaces.
If true, list who can perform the specified action in all namespaces.


.SH OPTIONS INHERITED FROM PARENT COMMANDS
Expand Down
4 changes: 2 additions & 2 deletions docs/man/man1/oc-adm-prune-builds.1
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ By default, the prune operation performs a dry run making no changes to internal
.SH OPTIONS
.PP
\fB\-\-confirm\fP=false
Specify that build pruning should proceed. Defaults to false, displaying what would be deleted but not actually deleting anything.
If true, specify that build pruning should proceed. Defaults to false, displaying what would be deleted but not actually deleting anything.

.PP
\fB\-\-keep\-complete\fP=5
Expand All @@ -38,7 +38,7 @@ By default, the prune operation performs a dry run making no changes to internal

.PP
\fB\-\-orphans\fP=false
Prune all builds whose associated BuildConfig no longer exists and whose status is complete, failed, error, or cancelled.
If true, prune all builds whose associated BuildConfig no longer exists and whose status is complete, failed, error, or cancelled.


.SH OPTIONS INHERITED FROM PARENT COMMANDS
Expand Down
4 changes: 2 additions & 2 deletions docs/man/man1/oc-adm-prune-deployments.1
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ By default, the prune operation performs a dry run making no changes to the depl
.SH OPTIONS
.PP
\fB\-\-confirm\fP=false
Specify that deployment pruning should proceed. Defaults to false, displaying what would be deleted but not actually deleting anything.
If true, specify that deployment pruning should proceed. Defaults to false, displaying what would be deleted but not actually deleting anything.

.PP
\fB\-\-keep\-complete\fP=5
Expand All @@ -38,7 +38,7 @@ By default, the prune operation performs a dry run making no changes to the depl

.PP
\fB\-\-orphans\fP=false
Prune all deployments where the associated DeploymentConfig no longer exists, the status is complete or failed, and the replica size is 0.
If true, prune all deployments where the associated DeploymentConfig no longer exists, the status is complete or failed, and the replica size is 0.


.SH OPTIONS INHERITED FROM PARENT COMMANDS
Expand Down
2 changes: 1 addition & 1 deletion docs/man/man1/oc-adm-prune-images.1
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Only a user with a cluster role system:image\-pruner or higher who is logged\-in

.PP
\fB\-\-confirm\fP=false
Specify that image pruning should proceed. Defaults to false, displaying what would be deleted but not actually deleting anything.
If true, specify that image pruning should proceed. Defaults to false, displaying what would be deleted but not actually deleting anything.

.PP
\fB\-\-keep\-tag\-revisions\fP=3
Expand Down
4 changes: 2 additions & 2 deletions docs/man/man1/oc-adm-registry.1
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,15 @@ NOTE: This command is intended to simplify the tasks of setting up a Docker regi

.PP
\fB\-\-daemonset\fP=false
Use a daemonset instead of a deployment config.
If true, use a daemonset instead of a deployment config.

.PP
\fB\-\-dry\-run\fP=false
If true, show the result of the operation without performing it.

.PP
\fB\-\-enforce\-quota\fP=false
If set, the registry will refuse to write blobs if they exceed quota limits
If true, the registry will refuse to write blobs if they exceed quota limits

.PP
\fB\-\-images\fP="openshift/origin\-${component}:${version}"
Expand Down
4 changes: 2 additions & 2 deletions docs/man/man1/oc-adm-router.1
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ If a router does not exist with the given name, this command will create a deplo

.PP
\fB\-\-expose\-metrics\fP=false
This is a hint to run an extra container in the pod to expose metrics \- the image will either be set depending on the router implementation or provided with \-\-metrics\-image.
If true, attempts to run an extra container in the pod to expose metrics \- the image will either be set depending on the router implementation or provided with \-\-metrics\-image.

.PP
\fB\-\-external\-host\fP=""
Expand Down Expand Up @@ -129,7 +129,7 @@ If a router does not exist with the given name, this command will create a deplo

.PP
\fB\-\-secrets\-as\-env\fP=false
Use environment variables for master secrets.
If true, use environment variables for master secrets.

.PP
\fB\-\-selector\fP=""
Expand Down
12 changes: 6 additions & 6 deletions docs/man/man1/oc-cluster-up.1
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ A public hostname can also be specified for the server with the \-\-public\-host
.SH OPTIONS
.PP
\fB\-\-create\-machine\fP=false
Create a Docker machine if one doesn't exist
If true, create a Docker machine if one doesn't exist

.PP
\fB\-\-docker\-machine\fP=""
Expand All @@ -43,7 +43,7 @@ A public hostname can also be specified for the server with the \-\-public\-host

.PP
\fB\-\-forward\-ports\fP=false
Use Docker port\-forwarding to communicate with origin container. Requires 'socat' locally.
If true, use Docker port\-forwarding to communicate with origin container. Requires 'socat' locally.

.PP
\fB\-\-host\-config\-dir\fP="/var/lib/origin/openshift.local.config"
Expand All @@ -63,11 +63,11 @@ A public hostname can also be specified for the server with the \-\-public\-host

.PP
\fB\-\-logging\fP=false
Install logging (experimental)
If true, install logging (experimental)

.PP
\fB\-\-metrics\fP=false
Install metrics (experimental)
If true, install metrics (experimental)

.PP
\fB\-\-public\-hostname\fP=""
Expand All @@ -83,11 +83,11 @@ A public hostname can also be specified for the server with the \-\-public\-host

.PP
\fB\-\-skip\-registry\-check\fP=false
Skip Docker daemon registry check
If true, skip Docker daemon registry check

.PP
\fB\-\-use\-existing\-config\fP=false
Use existing configuration if present
If true, use existing configuration if present

.PP
\fB\-\-version\fP=""
Expand Down
Loading

0 comments on commit 34069ee

Please sign in to comment.