diff --git a/docs/man/man1/oadm-build-chain.1 b/docs/man/man1/oadm-build-chain.1 index d36f0e061775..3b6f376c68d0 100644 --- a/docs/man/man1/oadm-build-chain.1 +++ b/docs/man/man1/oadm-build-chain.1 @@ -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="" diff --git a/docs/man/man1/oadm-diagnostics.1 b/docs/man/man1/oadm-diagnostics.1 index 6d341e4fcc25..91d38317d35f 100644 --- a/docs/man/man1/oadm-diagnostics.1 +++ b/docs/man/man1/oadm-diagnostics.1 @@ -63,7 +63,7 @@ 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}" @@ -71,7 +71,7 @@ The available diagnostic names are: AggregatedLogging, AnalyzeLogs, ClusterRegis .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 @@ -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 diff --git a/docs/man/man1/oadm-ipfailover.1 b/docs/man/man1/oadm-ipfailover.1 index a6632172c146..ae23f5384a97 100644 --- a/docs/man/man1/oadm-ipfailover.1 +++ b/docs/man/man1/oadm-ipfailover.1 @@ -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="" diff --git a/docs/man/man1/oadm-policy-reconcile-cluster-role-bindings.1 b/docs/man/man1/oadm-policy-reconcile-cluster-role-bindings.1 index fbbe13cd9252..52f74af6714e 100644 --- a/docs/man/man1/oadm-policy-reconcile-cluster-role-bindings.1 +++ b/docs/man/man1/oadm-policy-reconcile-cluster-role-bindings.1 @@ -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=[] diff --git a/docs/man/man1/oadm-policy-reconcile-cluster-roles.1 b/docs/man/man1/oadm-policy-reconcile-cluster-roles.1 index e242a163838d..1b6f985c2f88 100644 --- a/docs/man/man1/oadm-policy-reconcile-cluster-roles.1 +++ b/docs/man/man1/oadm-policy-reconcile-cluster-roles.1 @@ -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 diff --git a/docs/man/man1/oadm-policy-reconcile-sccs.1 b/docs/man/man1/oadm-policy-reconcile-sccs.1 index 7bff229ef775..5e91952d6b32 100644 --- a/docs/man/man1/oadm-policy-reconcile-sccs.1 +++ b/docs/man/man1/oadm-policy-reconcile-sccs.1 @@ -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" diff --git a/docs/man/man1/oadm-policy-who-can.1 b/docs/man/man1/oadm-policy-who-can.1 index a33133f3c1d5..77fa71a3a559 100644 --- a/docs/man/man1/oadm-policy-who-can.1 +++ b/docs/man/man1/oadm-policy-who-can.1 @@ -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 diff --git a/docs/man/man1/oadm-prune-builds.1 b/docs/man/man1/oadm-prune-builds.1 index e8877d889465..b314aa762501 100644 --- a/docs/man/man1/oadm-prune-builds.1 +++ b/docs/man/man1/oadm-prune-builds.1 @@ -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 @@ -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 diff --git a/docs/man/man1/oadm-prune-deployments.1 b/docs/man/man1/oadm-prune-deployments.1 index 341102535cb9..dbc7b8d64c83 100644 --- a/docs/man/man1/oadm-prune-deployments.1 +++ b/docs/man/man1/oadm-prune-deployments.1 @@ -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 @@ -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 diff --git a/docs/man/man1/oadm-prune-images.1 b/docs/man/man1/oadm-prune-images.1 index 340dcb210ffc..2fdb46e35b9e 100644 --- a/docs/man/man1/oadm-prune-images.1 +++ b/docs/man/man1/oadm-prune-images.1 @@ -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 diff --git a/docs/man/man1/oadm-registry.1 b/docs/man/man1/oadm-registry.1 index 56276c5d1214..b382f92a6bca 100644 --- a/docs/man/man1/oadm-registry.1 +++ b/docs/man/man1/oadm-registry.1 @@ -39,7 +39,7 @@ 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 @@ -47,7 +47,7 @@ NOTE: This command is intended to simplify the tasks of setting up a Docker regi .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}" diff --git a/docs/man/man1/oadm-router.1 b/docs/man/man1/oadm-router.1 index 8f412b23ae71..eef5b9275300 100644 --- a/docs/man/man1/oadm-router.1 +++ b/docs/man/man1/oadm-router.1 @@ -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="" @@ -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="" diff --git a/docs/man/man1/oc-adm-build-chain.1 b/docs/man/man1/oc-adm-build-chain.1 index bc5a0f3c4dba..1a896e89b720 100644 --- a/docs/man/man1/oc-adm-build-chain.1 +++ b/docs/man/man1/oc-adm-build-chain.1 @@ -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="" diff --git a/docs/man/man1/oc-adm-diagnostics.1 b/docs/man/man1/oc-adm-diagnostics.1 index 96aa645b39fd..8b269ba84fc6 100644 --- a/docs/man/man1/oc-adm-diagnostics.1 +++ b/docs/man/man1/oc-adm-diagnostics.1 @@ -63,7 +63,7 @@ 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}" @@ -71,7 +71,7 @@ The available diagnostic names are: AggregatedLogging, AnalyzeLogs, ClusterRegis .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 @@ -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 diff --git a/docs/man/man1/oc-adm-ipfailover.1 b/docs/man/man1/oc-adm-ipfailover.1 index 0cb73f2bba7b..9d8bb43efc7c 100644 --- a/docs/man/man1/oc-adm-ipfailover.1 +++ b/docs/man/man1/oc-adm-ipfailover.1 @@ -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="" diff --git a/docs/man/man1/oc-adm-policy-reconcile-cluster-role-bindings.1 b/docs/man/man1/oc-adm-policy-reconcile-cluster-role-bindings.1 index 53c6db5310d4..d9bb271f8430 100644 --- a/docs/man/man1/oc-adm-policy-reconcile-cluster-role-bindings.1 +++ b/docs/man/man1/oc-adm-policy-reconcile-cluster-role-bindings.1 @@ -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=[] diff --git a/docs/man/man1/oc-adm-policy-reconcile-cluster-roles.1 b/docs/man/man1/oc-adm-policy-reconcile-cluster-roles.1 index 78e73a2819a6..d5dbbf9394ff 100644 --- a/docs/man/man1/oc-adm-policy-reconcile-cluster-roles.1 +++ b/docs/man/man1/oc-adm-policy-reconcile-cluster-roles.1 @@ -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 diff --git a/docs/man/man1/oc-adm-policy-reconcile-sccs.1 b/docs/man/man1/oc-adm-policy-reconcile-sccs.1 index ed54b6a09393..35bac4482a16 100644 --- a/docs/man/man1/oc-adm-policy-reconcile-sccs.1 +++ b/docs/man/man1/oc-adm-policy-reconcile-sccs.1 @@ -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" diff --git a/docs/man/man1/oc-adm-policy-who-can.1 b/docs/man/man1/oc-adm-policy-who-can.1 index 73dc8c134878..3c834011d3b9 100644 --- a/docs/man/man1/oc-adm-policy-who-can.1 +++ b/docs/man/man1/oc-adm-policy-who-can.1 @@ -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 diff --git a/docs/man/man1/oc-adm-prune-builds.1 b/docs/man/man1/oc-adm-prune-builds.1 index 47749b882dce..6f9c75e26ffa 100644 --- a/docs/man/man1/oc-adm-prune-builds.1 +++ b/docs/man/man1/oc-adm-prune-builds.1 @@ -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 @@ -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 diff --git a/docs/man/man1/oc-adm-prune-deployments.1 b/docs/man/man1/oc-adm-prune-deployments.1 index 0d512f4f3c51..d0a5ee9a50a6 100644 --- a/docs/man/man1/oc-adm-prune-deployments.1 +++ b/docs/man/man1/oc-adm-prune-deployments.1 @@ -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 @@ -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 diff --git a/docs/man/man1/oc-adm-prune-images.1 b/docs/man/man1/oc-adm-prune-images.1 index 195e8c2768d8..b54661b01582 100644 --- a/docs/man/man1/oc-adm-prune-images.1 +++ b/docs/man/man1/oc-adm-prune-images.1 @@ -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 diff --git a/docs/man/man1/oc-adm-registry.1 b/docs/man/man1/oc-adm-registry.1 index ebc216cd49ea..294a97d20fe5 100644 --- a/docs/man/man1/oc-adm-registry.1 +++ b/docs/man/man1/oc-adm-registry.1 @@ -39,7 +39,7 @@ 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 @@ -47,7 +47,7 @@ NOTE: This command is intended to simplify the tasks of setting up a Docker regi .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}" diff --git a/docs/man/man1/oc-adm-router.1 b/docs/man/man1/oc-adm-router.1 index 7fc20ae0b81e..7d04db4691eb 100644 --- a/docs/man/man1/oc-adm-router.1 +++ b/docs/man/man1/oc-adm-router.1 @@ -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="" @@ -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="" diff --git a/docs/man/man1/oc-cluster-up.1 b/docs/man/man1/oc-cluster-up.1 index 7a25a4e9042e..2e9768f8aced 100644 --- a/docs/man/man1/oc-cluster-up.1 +++ b/docs/man/man1/oc-cluster-up.1 @@ -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="" @@ -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" @@ -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="" @@ -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="" diff --git a/docs/man/man1/oc-debug.1 b/docs/man/man1/oc-debug.1 index 608b13a0726f..3a8ca2fc3bf8 100644 --- a/docs/man/man1/oc-debug.1 +++ b/docs/man/man1/oc-debug.1 @@ -31,7 +31,7 @@ The debug pod is deleted when the the remote command completes or the user inter .SH OPTIONS .PP \fB\-\-as\-root\fP=false - Try to run the container as the root user + If true, try to run the container as the root user .PP \fB\-\-as\-user\fP=\-1 @@ -47,7 +47,7 @@ The debug pod is deleted when the the remote command completes or the user inter .PP \fB\-\-keep\-annotations\fP=false - Keep the original pod annotations + If true, keep the original pod annotations .PP \fB\-\-keep\-init\-containers\fP=true @@ -55,11 +55,11 @@ The debug pod is deleted when the the remote command completes or the user inter .PP \fB\-\-keep\-liveness\fP=false - Keep the original pod liveness probes + If true, keep the original pod liveness probes .PP \fB\-\-keep\-readiness\fP=false - Keep the original pod readiness probes + If true, keep the original pod readiness probes .PP \fB\-I\fP, \fB\-\-no\-stdin\fP=false @@ -75,7 +75,7 @@ The debug pod is deleted when the the remote command completes or the user inter .PP \fB\-\-one\-container\fP=false - Run only the selected container, remove all others + If true, run only the selected container, remove all others .PP \fB\-o\fP, \fB\-\-output\fP="" diff --git a/docs/man/man1/oc-deploy.1 b/docs/man/man1/oc-deploy.1 index f88be6b211a0..2477d37d249c 100644 --- a/docs/man/man1/oc-deploy.1 +++ b/docs/man/man1/oc-deploy.1 @@ -44,23 +44,23 @@ If no options are given, shows information about the latest deployment. .SH OPTIONS .PP \fB\-\-cancel\fP=false - Cancel the in\-progress deployment. + If true, cancel the in\-progress deployment. .PP \fB\-\-enable\-triggers\fP=false - Enables all image triggers for the deployment config. + If true, enables all image triggers for the deployment config. .PP \fB\-\-follow\fP=false - Follow the logs of a deployment + If true, follow the logs of a deployment .PP \fB\-\-latest\fP=false - Start a new deployment now. + If true, start a new deployment now. .PP \fB\-\-retry\fP=false - Retry the latest failed deployment. + If true, retry the latest failed deployment. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-env.1 b/docs/man/man1/oc-env.1 index 1ae3716e74c0..278057caaf04 100644 --- a/docs/man/man1/oc-env.1 +++ b/docs/man/man1/oc-env.1 @@ -19,7 +19,7 @@ DEPRECATED: This command has been moved to "oc set env" .SH OPTIONS .PP \fB\-\-all\fP=false - Select all resources in the namespace of the specified resource types + If true, select all resources in the namespace of the specified resource types .PP \fB\-c\fP, \fB\-\-containers\fP="*" @@ -39,7 +39,7 @@ DEPRECATED: This command has been moved to "oc set env" .PP \fB\-\-list\fP=false - Display the environment and any changes in the standard format + If true, display the environment and any changes in the standard format .PP \fB\-\-no\-headers\fP=false @@ -66,7 +66,7 @@ DEPRECATED: This command has been moved to "oc set env" .PP \fB\-\-resolve\fP=false - Show secret or configmap references when listing variables + If true, show secret or configmap references when listing variables .PP \fB\-\-resource\-version\fP="" diff --git a/docs/man/man1/oc-export.1 b/docs/man/man1/oc-export.1 index 3a3d0f0ffd18..afec7a8a686d 100644 --- a/docs/man/man1/oc-export.1 +++ b/docs/man/man1/oc-export.1 @@ -32,7 +32,7 @@ Another use case for export is to create reusable templates for applications. Pa .PP \fB\-\-all\-namespaces\fP=false - If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with \-\-namespace. + If true, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with \-\-namespace. .PP \fB\-\-as\-template\fP="" @@ -40,7 +40,7 @@ Another use case for export is to create reusable templates for applications. Pa .PP \fB\-\-exact\fP=false - Preserve fields that may be cluster specific, such as service clusterIPs or generated names + If true, preserve fields that may be cluster specific, such as service clusterIPs or generated names .PP \fB\-f\fP, \fB\-\-filename\fP=[] diff --git a/docs/man/man1/oc-extract.1 b/docs/man/man1/oc-extract.1 index f6e8d61daf71..e4033be48b44 100644 --- a/docs/man/man1/oc-extract.1 +++ b/docs/man/man1/oc-extract.1 @@ -25,7 +25,7 @@ You can limit which keys are extracted with the \-\-keys=NAME flag, or set the d .SH OPTIONS .PP \fB\-\-confirm\fP=false - Overwrite files that already exist. + If true, overwrite files that already exist. .PP \fB\-f\fP, \fB\-\-filename\fP=[] diff --git a/docs/man/man1/oc-idle.1 b/docs/man/man1/oc-idle.1 index fdafb5d1a072..8e733a6e5ac4 100644 --- a/docs/man/man1/oc-idle.1 +++ b/docs/man/man1/oc-idle.1 @@ -25,11 +25,11 @@ Upon receiving network traffic, the services (and any associated routes) will "w .SH OPTIONS .PP \fB\-\-all\fP=false - Select all services in the namespace + if true, select all services in the namespace .PP \fB\-\-all\-namespaces\fP=false - Select services across all namespaces + if true, select services across all namespaces .PP \fB\-\-dry\-run\fP=false diff --git a/docs/man/man1/oc-new-build.1 b/docs/man/man1/oc-new-build.1 index ff6d83bb0bdb..4541fac37da9 100644 --- a/docs/man/man1/oc-new-build.1 +++ b/docs/man/man1/oc-new-build.1 @@ -112,7 +112,7 @@ Once the build configuration is created a new build will be automatically trigge .PP \fB\-\-to\-docker\fP=false - Have the build output push to a Docker repository. + If true, have the build output push to a Docker repository. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-observe.1 b/docs/man/man1/oc-observe.1 index bbd1646dbecc..8ba4b670c4bd 100644 --- a/docs/man/man1/oc-observe.1 +++ b/docs/man/man1/oc-observe.1 @@ -102,7 +102,7 @@ Experimental: This command is under active development and may change without no .SH OPTIONS .PP \fB\-\-all\-namespaces\fP=false - If present, list the requested object(s) across all projects. Project in current context is ignored. + If true, list the requested object(s) across all projects. Project in current context is ignored. .PP \fB\-a\fP, \fB\-\-argument\fP="" @@ -130,7 +130,7 @@ Experimental: This command is under active development and may change without no .PP \fB\-\-no\-headers\fP=false - Skip printing information about each event prior to executing the command. + If true, skip printing information about each event prior to executing the command. .PP \fB\-\-object\-env\-var\fP="" @@ -138,7 +138,7 @@ Experimental: This command is under active development and may change without no .PP \fB\-\-once\fP=false - Exit with a status code 0 after all current objects have been processed. + If true, exit with a status code 0 after all current objects have been processed. .PP \fB\-\-output\fP="jsonpath" @@ -146,7 +146,7 @@ Experimental: This command is under active development and may change without no .PP \fB\-\-print\-metrics\-on\-exit\fP=false - On exit write all metrics to stdout. + If true, on exit write all metrics to stdout. .PP \fB\-\-resync\-period\fP=0 diff --git a/docs/man/man1/oc-policy-can-i.1 b/docs/man/man1/oc-policy-can-i.1 index 1db67cb2c34b..ff94a4949d5a 100644 --- a/docs/man/man1/oc-policy-can-i.1 +++ b/docs/man/man1/oc-policy-can-i.1 @@ -19,7 +19,7 @@ Check whether an action is allowed .SH OPTIONS .PP \fB\-\-all\-namespaces\fP=false - Check the specified action in all namespaces. + If true, check the specified action in all namespaces. .PP \fB\-\-groups\fP=[] @@ -27,15 +27,15 @@ Check whether an action is allowed .PP \fB\-\-ignore\-scopes\fP=false - Disregard any scopes present on this request and evaluate considering full permissions. + If true, disregard any scopes present on this request and evaluate considering full permissions. .PP \fB\-\-list\fP=false - List all the actions you can perform in a namespace, cannot be specified with \-\-all\-namespaces or a VERB RESOURCE + If true, list all the actions you can perform in a namespace, cannot be specified with \-\-all\-namespaces or a VERB RESOURCE .PP \fB\-q\fP, \fB\-\-quiet\fP=false - Suppress output and just return the exit code. + If true, suppress output and just return the exit code. .PP \fB\-\-scopes\fP=[] diff --git a/docs/man/man1/oc-policy-who-can.1 b/docs/man/man1/oc-policy-who-can.1 index 4dd345196adb..c23663fddbb1 100644 --- a/docs/man/man1/oc-policy-who-can.1 +++ b/docs/man/man1/oc-policy-who-can.1 @@ -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 diff --git a/docs/man/man1/oc-process.1 b/docs/man/man1/oc-process.1 index eb6cee027b2b..4cdf1b1e5fea 100644 --- a/docs/man/man1/oc-process.1 +++ b/docs/man/man1/oc-process.1 @@ -33,7 +33,7 @@ The output of the process command is always a list of one or more resources. You .PP \fB\-o\fP, \fB\-\-output\fP="json" - Output format. One of: describe|json|yaml|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=... + Output format. One of: describe|json|yaml|name|template|templatefile. .PP \fB\-\-output\-version\fP="" @@ -45,15 +45,15 @@ The output of the process command is always a list of one or more resources. You .PP \fB\-\-parameters\fP=false - Do not process but only print available parameters + If true, do not process but only print available parameters .PP \fB\-\-raw\fP=false - If true output the processed template instead of the template's objects. Implied by \-o describe + If true, output the processed template instead of the template's objects. Implied by \-o describe .PP \fB\-t\fP, \fB\-\-template\fP="" - Template string or path to template file to use when \-o=go\-template, \-o=go\-templatefile. The template format is golang templates [ + Template string or path to template file to use when \-o=template or \-o=templatefile. The template format is golang templates [ \[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]] diff --git a/docs/man/man1/oc-rollback.1 b/docs/man/man1/oc-rollback.1 index 88b988a412d3..795e7052b65b 100644 --- a/docs/man/man1/oc-rollback.1 +++ b/docs/man/man1/oc-rollback.1 @@ -28,15 +28,15 @@ If you would like to review the outcome of the rollback, pass '\-\-dry\-run' to .SH OPTIONS .PP \fB\-\-change\-scaling\-settings\fP=false - Include the previous deployment's replicationController replica count and selector in the rollback + If true, include the previous deployment's replicationController replica count and selector in the rollback .PP \fB\-\-change\-strategy\fP=false - Include the previous deployment's strategy in the rollback + If true, include the previous deployment's strategy in the rollback .PP \fB\-\-change\-triggers\fP=false - Include the previous deployment's triggers in the rollback + If true, include the previous deployment's triggers in the rollback .PP \fB\-d\fP, \fB\-\-dry\-run\fP=false diff --git a/docs/man/man1/oc-rollout-latest.1 b/docs/man/man1/oc-rollout-latest.1 index 060d6c32e542..6d6025ae9294 100644 --- a/docs/man/man1/oc-rollout-latest.1 +++ b/docs/man/man1/oc-rollout-latest.1 @@ -22,7 +22,7 @@ This command is appropriate for running manual rollouts. If you want full contro .SH OPTIONS .PP \fB\-\-again\fP=false - Deploy the current pod template without updating state from triggers + If true, deploy the current pod template without updating state from triggers .PP \fB\-\-dry\-run\fP=false diff --git a/docs/man/man1/oc-rsync.1 b/docs/man/man1/oc-rsync.1 index 6ca68ae5f1c7..5bc9aa5501b9 100644 --- a/docs/man/man1/oc-rsync.1 +++ b/docs/man/man1/oc-rsync.1 @@ -30,23 +30,23 @@ If no container is specified, the first container of the pod is used for the cop .PP \fB\-\-delete\fP=false - Delete files not present in source + If true, delete files not present in source .PP \fB\-\-exclude\fP=[] - rsync \- exclude files matching specified pattern + If true, exclude files matching specified pattern .PP \fB\-\-include\fP=[] - rsync \- include files matching specified pattern + If true, include files matching specified pattern .PP \fB\-\-no\-perms\fP=false - rsync \- do not transfer permissions + If true, do not transfer permissions .PP \fB\-\-progress\fP=false - rsync \- show progress during transfer + If true, show progress during transfer .PP \fB\-q\fP, \fB\-\-quiet\fP=false diff --git a/docs/man/man1/oc-secrets-new-basicauth.1 b/docs/man/man1/oc-secrets-new-basicauth.1 index b414ae91e0cf..ca234ebd93f1 100644 --- a/docs/man/man1/oc-secrets-new-basicauth.1 +++ b/docs/man/man1/oc-secrets-new-basicauth.1 @@ -52,7 +52,7 @@ When creating applications, you may have a SCM server that requires basic authen .PP \fB\-\-prompt\fP=false - Prompt for password or token + If true, prompt for password or token .PP \fB\-a\fP, \fB\-\-show\-all\fP=true diff --git a/docs/man/man1/oc-secrets-new.1 b/docs/man/man1/oc-secrets-new.1 index 22b0bc5f5309..8a3d3c6c9150 100644 --- a/docs/man/man1/oc-secrets-new.1 +++ b/docs/man/man1/oc-secrets-new.1 @@ -22,7 +22,7 @@ Key files can be specified using their file path, in which case a default name w .SH OPTIONS .PP \fB\-\-confirm\fP=false - Allow unknown secret types. + If true, allow unknown secret types. .PP \fB\-\-no\-headers\fP=false @@ -41,7 +41,7 @@ Key files can be specified using their file path, in which case a default name w .PP \fB\-q\fP, \fB\-\-quiet\fP=false - Suppress warnings + If true, suppress warnings .PP \fB\-a\fP, \fB\-\-show\-all\fP=true diff --git a/docs/man/man1/oc-set-build-hook.1 b/docs/man/man1/oc-set-build-hook.1 index 5bd8996e34b4..2fdfe6d304fd 100644 --- a/docs/man/man1/oc-set-build-hook.1 +++ b/docs/man/man1/oc-set-build-hook.1 @@ -28,7 +28,7 @@ The command for a build hook may be specified as a shell script (with the \-\-sc .SH OPTIONS .PP \fB\-\-all\fP=false - Select all build configs in the namespace + If true, select all build configs in the namespace .PP \fB\-\-command\fP=false diff --git a/docs/man/man1/oc-set-build-secret.1 b/docs/man/man1/oc-set-build-secret.1 index 9fd0a9dca652..330829287f72 100644 --- a/docs/man/man1/oc-set-build-secret.1 +++ b/docs/man/man1/oc-set-build-secret.1 @@ -28,7 +28,7 @@ A label selector may be specified with the \-\-selector flag to select the build .SH OPTIONS .PP \fB\-\-all\fP=false - Select all build configs in the namespace + If true, select all build configs in the namespace .PP \fB\-f\fP, \fB\-\-filename\fP=[] diff --git a/docs/man/man1/oc-set-deployment-hook.1 b/docs/man/man1/oc-set-deployment-hook.1 index 8295bc2b1fed..4b029d43bc82 100644 --- a/docs/man/man1/oc-set-deployment-hook.1 +++ b/docs/man/man1/oc-set-deployment-hook.1 @@ -34,7 +34,7 @@ Each hook can have its own cancellation policy. One of: abort, retry, or ignore. .SH OPTIONS .PP \fB\-\-all\fP=false - Select all deployment configs in the namespace + If true, select all deployment configs in the namespace .PP \fB\-c\fP, \fB\-\-container\fP="" diff --git a/docs/man/man1/oc-set-env.1 b/docs/man/man1/oc-set-env.1 index b2d2d87a4cb1..b5a46eac8ae3 100644 --- a/docs/man/man1/oc-set-env.1 +++ b/docs/man/man1/oc-set-env.1 @@ -25,7 +25,7 @@ If "\-\-env \-" is passed, environment variables can be read from STDIN using th .SH OPTIONS .PP \fB\-\-all\fP=false - Select all resources in the namespace of the specified resource types + If true, select all resources in the namespace of the specified resource types .PP \fB\-c\fP, \fB\-\-containers\fP="*" @@ -45,7 +45,7 @@ If "\-\-env \-" is passed, environment variables can be read from STDIN using th .PP \fB\-\-list\fP=false - Display the environment and any changes in the standard format + If true, display the environment and any changes in the standard format .PP \fB\-\-no\-headers\fP=false @@ -72,7 +72,7 @@ If "\-\-env \-" is passed, environment variables can be read from STDIN using th .PP \fB\-\-resolve\fP=false - Show secret or configmap references when listing variables + If true, show secret or configmap references when listing variables .PP \fB\-\-resource\-version\fP="" diff --git a/docs/man/man1/oc-set-probe.1 b/docs/man/man1/oc-set-probe.1 index aa7499206d5e..8c54bf8b937f 100644 --- a/docs/man/man1/oc-set-probe.1 +++ b/docs/man/man1/oc-set-probe.1 @@ -38,7 +38,7 @@ Containers that take a variable amount of time to start should set generous init .SH OPTIONS .PP \fB\-\-all\fP=false - Select all resources in the namespace of the specified resource types + If true, select all resources in the namespace of the specified resource types .PP \fB\-c\fP, \fB\-\-containers\fP="*" diff --git a/docs/man/man1/oc-set-route-backends.1 b/docs/man/man1/oc-set-route-backends.1 index d9047f32e14c..a4266eaccc66 100644 --- a/docs/man/man1/oc-set-route-backends.1 +++ b/docs/man/man1/oc-set-route-backends.1 @@ -41,11 +41,11 @@ Not all routers may support multiple or weighted backends. .PP \fB\-\-all\fP=false - Select all resources in the namespace of the specified resource types + If true, select all resources in the namespace of the specified resource types .PP \fB\-\-equal\fP=false - Set the weight of all backends to 100. + If true, set the weight of all backends to 100. .PP \fB\-f\fP, \fB\-\-filename\fP=[] @@ -89,7 +89,7 @@ Not all routers may support multiple or weighted backends. .PP \fB\-\-zero\fP=false - Set the weight of all backends to zero. + If true, set the weight of all backends to zero. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/oc-set-triggers.1 b/docs/man/man1/oc-set-triggers.1 index cb82c53505fd..900b393d4b2f 100644 --- a/docs/man/man1/oc-set-triggers.1 +++ b/docs/man/man1/oc-set-triggers.1 @@ -28,11 +28,11 @@ Build configs support triggering off of image changes, config changes, and webho .SH OPTIONS .PP \fB\-\-all\fP=false - Select all resources in the namespace of the specified resource types + If true, select all resources in the namespace of the specified resource types .PP \fB\-\-auto\fP=false - Enable all triggers, or just the specified trigger + If true, enable all triggers, or just the specified trigger .PP \fB\-c\fP, \fB\-\-containers\fP="" @@ -48,7 +48,7 @@ Build configs support triggering off of image changes, config changes, and webho .PP \fB\-\-from\-github\fP=false - A GitHub webhook \- a secret value will be generated automatically + If true, a GitHub webhook \- a secret value will be generated automatically .PP \fB\-\-from\-image\fP="" @@ -56,15 +56,15 @@ Build configs support triggering off of image changes, config changes, and webho .PP \fB\-\-from\-webhook\fP=false - A generic webhook \- a secret value will be generated automatically + If true, a generic webhook \- a secret value will be generated automatically .PP \fB\-\-from\-webhook\-allow\-env\fP=false - A generic webhook which can provide environment variables \- a secret value will be generated automatically + If true, a generic webhook which can provide environment variables \- a secret value will be generated automatically .PP \fB\-\-manual\fP=false - Set all triggers to manual, or just the specified trigger + If true, set all triggers to manual, or just the specified trigger .PP \fB\-\-no\-headers\fP=false diff --git a/docs/man/man1/oc-set-volumes.1 b/docs/man/man1/oc-set-volumes.1 index f8e01d85ff4f..f629b28da7cd 100644 --- a/docs/man/man1/oc-set-volumes.1 +++ b/docs/man/man1/oc-set-volumes.1 @@ -45,11 +45,11 @@ For descriptions on other volume types, see .SH OPTIONS .PP \fB\-\-add\fP=false - Add volume and/or volume mounts for containers + If true, add volume and/or volume mounts for containers .PP \fB\-\-all\fP=false - select all resources in the namespace of the specified resource types + If true, select all resources in the namespace of the specified resource types .PP \fB\-\-claim\-class\fP="" @@ -73,7 +73,7 @@ For descriptions on other volume types, see .PP \fB\-\-confirm\fP=false - Confirm that you really want to remove multiple volumes + If true, confirm that you really want to remove multiple volumes .PP \fB\-c\fP, \fB\-\-containers\fP="*" @@ -85,7 +85,7 @@ For descriptions on other volume types, see .PP \fB\-\-list\fP=false - List volumes and volume mounts for containers + If true, list volumes and volume mounts for containers .PP \fB\-m\fP, \fB\-\-mount\-path\fP="" @@ -120,7 +120,7 @@ For descriptions on other volume types, see .PP \fB\-\-remove\fP=false - Remove volume and/or volume mounts for containers + If true, remove volume and/or volume mounts for containers .PP \fB\-\-secret\-name\fP="" diff --git a/docs/man/man1/oc-status.1 b/docs/man/man1/oc-status.1 index 9ee4ed175222..c2d65c4965d2 100644 --- a/docs/man/man1/oc-status.1 +++ b/docs/man/man1/oc-status.1 @@ -25,7 +25,7 @@ You can specify an output format of "\-o dot" to have this command output the ge .SH OPTIONS .PP \fB\-\-all\-namespaces\fP=false - Display status for all namespaces (must have cluster admin) + If true, display status for all namespaces (must have cluster admin) .PP \fB\-o\fP, \fB\-\-output\fP="" diff --git a/docs/man/man1/oc-tag.1 b/docs/man/man1/oc-tag.1 index baa9c4689194..446be1bf9170 100644 --- a/docs/man/man1/oc-tag.1 +++ b/docs/man/man1/oc-tag.1 @@ -33,7 +33,7 @@ Pass the \-\-insecure flag if your external registry does not have a valid HTTPS .PP \fB\-\-insecure\fP=false - Set to true if importing the specified Docker image requires HTTP or has a self\-signed certificate. + Set to true if importing the specified Docker image requires HTTP or has a self\-signed certificate. Defaults to false. .PP \fB\-\-reference\fP=false @@ -41,7 +41,7 @@ Pass the \-\-insecure flag if your external registry does not have a valid HTTPS .PP \fB\-\-scheduled\fP=false - Set a Docker image to be periodically imported from a remote repository. + Set a Docker image to be periodically imported from a remote repository. Defaults to false. .PP \fB\-\-source\fP="" diff --git a/docs/man/man1/oc-volumes.1 b/docs/man/man1/oc-volumes.1 index b35ec6a99f4d..51ee49a5e0e8 100644 --- a/docs/man/man1/oc-volumes.1 +++ b/docs/man/man1/oc-volumes.1 @@ -19,11 +19,11 @@ DEPRECATED: This command has been moved to "oc set volume" .SH OPTIONS .PP \fB\-\-add\fP=false - Add volume and/or volume mounts for containers + If true, add volume and/or volume mounts for containers .PP \fB\-\-all\fP=false - select all resources in the namespace of the specified resource types + If true, select all resources in the namespace of the specified resource types .PP \fB\-\-claim\-class\fP="" @@ -47,7 +47,7 @@ DEPRECATED: This command has been moved to "oc set volume" .PP \fB\-\-confirm\fP=false - Confirm that you really want to remove multiple volumes + If true, confirm that you really want to remove multiple volumes .PP \fB\-c\fP, \fB\-\-containers\fP="*" @@ -59,7 +59,7 @@ DEPRECATED: This command has been moved to "oc set volume" .PP \fB\-\-list\fP=false - List volumes and volume mounts for containers + If true, list volumes and volume mounts for containers .PP \fB\-m\fP, \fB\-\-mount\-path\fP="" @@ -94,7 +94,7 @@ DEPRECATED: This command has been moved to "oc set volume" .PP \fB\-\-remove\fP=false - Remove volume and/or volume mounts for containers + If true, remove volume and/or volume mounts for containers .PP \fB\-\-secret\-name\fP="" diff --git a/docs/man/man1/oc-whoami.1 b/docs/man/man1/oc-whoami.1 index 19decdd8ce80..11835c3d4b89 100644 --- a/docs/man/man1/oc-whoami.1 +++ b/docs/man/man1/oc-whoami.1 @@ -26,7 +26,7 @@ The default options for this command will return the currently authenticated use .PP \fB\-\-show\-server\fP=false - Print the current server's REST API URL + If true, print the current server's REST API URL .PP \fB\-t\fP, \fB\-\-show\-token\fP=false diff --git a/docs/man/man1/openshift-admin-build-chain.1 b/docs/man/man1/openshift-admin-build-chain.1 index 2bbe3e7d55cf..5694841bf085 100644 --- a/docs/man/man1/openshift-admin-build-chain.1 +++ b/docs/man/man1/openshift-admin-build-chain.1 @@ -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="" diff --git a/docs/man/man1/openshift-admin-diagnostics.1 b/docs/man/man1/openshift-admin-diagnostics.1 index 40430e717799..372d7e92c4d2 100644 --- a/docs/man/man1/openshift-admin-diagnostics.1 +++ b/docs/man/man1/openshift-admin-diagnostics.1 @@ -63,7 +63,7 @@ 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}" @@ -71,7 +71,7 @@ The available diagnostic names are: AggregatedLogging, AnalyzeLogs, ClusterRegis .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 @@ -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 diff --git a/docs/man/man1/openshift-admin-ipfailover.1 b/docs/man/man1/openshift-admin-ipfailover.1 index 5a53bf497150..8300d33499c9 100644 --- a/docs/man/man1/openshift-admin-ipfailover.1 +++ b/docs/man/man1/openshift-admin-ipfailover.1 @@ -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="" diff --git a/docs/man/man1/openshift-admin-policy-reconcile-cluster-role-bindings.1 b/docs/man/man1/openshift-admin-policy-reconcile-cluster-role-bindings.1 index 688602d1e059..7e35f57f5838 100644 --- a/docs/man/man1/openshift-admin-policy-reconcile-cluster-role-bindings.1 +++ b/docs/man/man1/openshift-admin-policy-reconcile-cluster-role-bindings.1 @@ -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=[] diff --git a/docs/man/man1/openshift-admin-policy-reconcile-cluster-roles.1 b/docs/man/man1/openshift-admin-policy-reconcile-cluster-roles.1 index 15d8d7cbf736..ad35f535a5a9 100644 --- a/docs/man/man1/openshift-admin-policy-reconcile-cluster-roles.1 +++ b/docs/man/man1/openshift-admin-policy-reconcile-cluster-roles.1 @@ -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 diff --git a/docs/man/man1/openshift-admin-policy-reconcile-sccs.1 b/docs/man/man1/openshift-admin-policy-reconcile-sccs.1 index 466d619e5d33..b84c9abcf421 100644 --- a/docs/man/man1/openshift-admin-policy-reconcile-sccs.1 +++ b/docs/man/man1/openshift-admin-policy-reconcile-sccs.1 @@ -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" diff --git a/docs/man/man1/openshift-admin-policy-who-can.1 b/docs/man/man1/openshift-admin-policy-who-can.1 index f488d636aed5..25645ae874d9 100644 --- a/docs/man/man1/openshift-admin-policy-who-can.1 +++ b/docs/man/man1/openshift-admin-policy-who-can.1 @@ -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 diff --git a/docs/man/man1/openshift-admin-prune-builds.1 b/docs/man/man1/openshift-admin-prune-builds.1 index 21ab94130df4..53976519e29a 100644 --- a/docs/man/man1/openshift-admin-prune-builds.1 +++ b/docs/man/man1/openshift-admin-prune-builds.1 @@ -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 @@ -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 diff --git a/docs/man/man1/openshift-admin-prune-deployments.1 b/docs/man/man1/openshift-admin-prune-deployments.1 index 90459b99dfea..98b368894479 100644 --- a/docs/man/man1/openshift-admin-prune-deployments.1 +++ b/docs/man/man1/openshift-admin-prune-deployments.1 @@ -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 @@ -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 diff --git a/docs/man/man1/openshift-admin-prune-images.1 b/docs/man/man1/openshift-admin-prune-images.1 index c733cd178369..e193d3b2f683 100644 --- a/docs/man/man1/openshift-admin-prune-images.1 +++ b/docs/man/man1/openshift-admin-prune-images.1 @@ -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 diff --git a/docs/man/man1/openshift-admin-registry.1 b/docs/man/man1/openshift-admin-registry.1 index 9bc01b449873..bf4c7330a883 100644 --- a/docs/man/man1/openshift-admin-registry.1 +++ b/docs/man/man1/openshift-admin-registry.1 @@ -39,7 +39,7 @@ 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 @@ -47,7 +47,7 @@ NOTE: This command is intended to simplify the tasks of setting up a Docker regi .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}" diff --git a/docs/man/man1/openshift-admin-router.1 b/docs/man/man1/openshift-admin-router.1 index 69b18a8bcad6..190b84b2c6e9 100644 --- a/docs/man/man1/openshift-admin-router.1 +++ b/docs/man/man1/openshift-admin-router.1 @@ -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="" @@ -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="" diff --git a/docs/man/man1/openshift-cli-adm-build-chain.1 b/docs/man/man1/openshift-cli-adm-build-chain.1 index 3bdf50b8592b..af43d3060ae7 100644 --- a/docs/man/man1/openshift-cli-adm-build-chain.1 +++ b/docs/man/man1/openshift-cli-adm-build-chain.1 @@ -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="" diff --git a/docs/man/man1/openshift-cli-adm-diagnostics.1 b/docs/man/man1/openshift-cli-adm-diagnostics.1 index 0a8730054eaf..641c1bf8ae5c 100644 --- a/docs/man/man1/openshift-cli-adm-diagnostics.1 +++ b/docs/man/man1/openshift-cli-adm-diagnostics.1 @@ -63,7 +63,7 @@ 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}" @@ -71,7 +71,7 @@ The available diagnostic names are: AggregatedLogging, AnalyzeLogs, ClusterRegis .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 @@ -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 diff --git a/docs/man/man1/openshift-cli-adm-ipfailover.1 b/docs/man/man1/openshift-cli-adm-ipfailover.1 index c0cf84be5943..5520621a70a8 100644 --- a/docs/man/man1/openshift-cli-adm-ipfailover.1 +++ b/docs/man/man1/openshift-cli-adm-ipfailover.1 @@ -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="" diff --git a/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-role-bindings.1 b/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-role-bindings.1 index 31c40dc9dcd1..358b5f12a97c 100644 --- a/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-role-bindings.1 +++ b/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-role-bindings.1 @@ -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=[] diff --git a/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-roles.1 b/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-roles.1 index 1666fb8cf419..2ffd5713eda3 100644 --- a/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-roles.1 +++ b/docs/man/man1/openshift-cli-adm-policy-reconcile-cluster-roles.1 @@ -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 diff --git a/docs/man/man1/openshift-cli-adm-policy-reconcile-sccs.1 b/docs/man/man1/openshift-cli-adm-policy-reconcile-sccs.1 index 0fcfb10ee5b1..2cb708062954 100644 --- a/docs/man/man1/openshift-cli-adm-policy-reconcile-sccs.1 +++ b/docs/man/man1/openshift-cli-adm-policy-reconcile-sccs.1 @@ -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" diff --git a/docs/man/man1/openshift-cli-adm-policy-who-can.1 b/docs/man/man1/openshift-cli-adm-policy-who-can.1 index 490f836524ca..013bf0dff26f 100644 --- a/docs/man/man1/openshift-cli-adm-policy-who-can.1 +++ b/docs/man/man1/openshift-cli-adm-policy-who-can.1 @@ -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 diff --git a/docs/man/man1/openshift-cli-adm-prune-builds.1 b/docs/man/man1/openshift-cli-adm-prune-builds.1 index 378936597d50..6f0fcbad9e4a 100644 --- a/docs/man/man1/openshift-cli-adm-prune-builds.1 +++ b/docs/man/man1/openshift-cli-adm-prune-builds.1 @@ -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 @@ -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 diff --git a/docs/man/man1/openshift-cli-adm-prune-deployments.1 b/docs/man/man1/openshift-cli-adm-prune-deployments.1 index 52dca5913228..6ce2db3b0ba0 100644 --- a/docs/man/man1/openshift-cli-adm-prune-deployments.1 +++ b/docs/man/man1/openshift-cli-adm-prune-deployments.1 @@ -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 @@ -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 diff --git a/docs/man/man1/openshift-cli-adm-prune-images.1 b/docs/man/man1/openshift-cli-adm-prune-images.1 index d25acce5b6d5..0f430436295a 100644 --- a/docs/man/man1/openshift-cli-adm-prune-images.1 +++ b/docs/man/man1/openshift-cli-adm-prune-images.1 @@ -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 diff --git a/docs/man/man1/openshift-cli-adm-registry.1 b/docs/man/man1/openshift-cli-adm-registry.1 index 6a0b5b73a82b..0754af846b1f 100644 --- a/docs/man/man1/openshift-cli-adm-registry.1 +++ b/docs/man/man1/openshift-cli-adm-registry.1 @@ -39,7 +39,7 @@ 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 @@ -47,7 +47,7 @@ NOTE: This command is intended to simplify the tasks of setting up a Docker regi .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}" diff --git a/docs/man/man1/openshift-cli-adm-router.1 b/docs/man/man1/openshift-cli-adm-router.1 index 2e3f3aa23567..0edfe30db0ea 100644 --- a/docs/man/man1/openshift-cli-adm-router.1 +++ b/docs/man/man1/openshift-cli-adm-router.1 @@ -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="" @@ -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="" diff --git a/docs/man/man1/openshift-cli-cluster-up.1 b/docs/man/man1/openshift-cli-cluster-up.1 index e7a2498641c1..091d9b6c7f7f 100644 --- a/docs/man/man1/openshift-cli-cluster-up.1 +++ b/docs/man/man1/openshift-cli-cluster-up.1 @@ -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="" @@ -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" @@ -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="" @@ -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="" diff --git a/docs/man/man1/openshift-cli-debug.1 b/docs/man/man1/openshift-cli-debug.1 index 23253ed1b496..442941250826 100644 --- a/docs/man/man1/openshift-cli-debug.1 +++ b/docs/man/man1/openshift-cli-debug.1 @@ -31,7 +31,7 @@ The debug pod is deleted when the the remote command completes or the user inter .SH OPTIONS .PP \fB\-\-as\-root\fP=false - Try to run the container as the root user + If true, try to run the container as the root user .PP \fB\-\-as\-user\fP=\-1 @@ -47,7 +47,7 @@ The debug pod is deleted when the the remote command completes or the user inter .PP \fB\-\-keep\-annotations\fP=false - Keep the original pod annotations + If true, keep the original pod annotations .PP \fB\-\-keep\-init\-containers\fP=true @@ -55,11 +55,11 @@ The debug pod is deleted when the the remote command completes or the user inter .PP \fB\-\-keep\-liveness\fP=false - Keep the original pod liveness probes + If true, keep the original pod liveness probes .PP \fB\-\-keep\-readiness\fP=false - Keep the original pod readiness probes + If true, keep the original pod readiness probes .PP \fB\-I\fP, \fB\-\-no\-stdin\fP=false @@ -75,7 +75,7 @@ The debug pod is deleted when the the remote command completes or the user inter .PP \fB\-\-one\-container\fP=false - Run only the selected container, remove all others + If true, run only the selected container, remove all others .PP \fB\-o\fP, \fB\-\-output\fP="" diff --git a/docs/man/man1/openshift-cli-deploy.1 b/docs/man/man1/openshift-cli-deploy.1 index 8a1c0c6dfba5..859c6348006b 100644 --- a/docs/man/man1/openshift-cli-deploy.1 +++ b/docs/man/man1/openshift-cli-deploy.1 @@ -44,23 +44,23 @@ If no options are given, shows information about the latest deployment. .SH OPTIONS .PP \fB\-\-cancel\fP=false - Cancel the in\-progress deployment. + If true, cancel the in\-progress deployment. .PP \fB\-\-enable\-triggers\fP=false - Enables all image triggers for the deployment config. + If true, enables all image triggers for the deployment config. .PP \fB\-\-follow\fP=false - Follow the logs of a deployment + If true, follow the logs of a deployment .PP \fB\-\-latest\fP=false - Start a new deployment now. + If true, start a new deployment now. .PP \fB\-\-retry\fP=false - Retry the latest failed deployment. + If true, retry the latest failed deployment. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-env.1 b/docs/man/man1/openshift-cli-env.1 index 5e6c5a98d6df..3058022b0b3d 100644 --- a/docs/man/man1/openshift-cli-env.1 +++ b/docs/man/man1/openshift-cli-env.1 @@ -19,7 +19,7 @@ DEPRECATED: This command has been moved to "openshift cli set env" .SH OPTIONS .PP \fB\-\-all\fP=false - Select all resources in the namespace of the specified resource types + If true, select all resources in the namespace of the specified resource types .PP \fB\-c\fP, \fB\-\-containers\fP="*" @@ -39,7 +39,7 @@ DEPRECATED: This command has been moved to "openshift cli set env" .PP \fB\-\-list\fP=false - Display the environment and any changes in the standard format + If true, display the environment and any changes in the standard format .PP \fB\-\-no\-headers\fP=false @@ -66,7 +66,7 @@ DEPRECATED: This command has been moved to "openshift cli set env" .PP \fB\-\-resolve\fP=false - Show secret or configmap references when listing variables + If true, show secret or configmap references when listing variables .PP \fB\-\-resource\-version\fP="" diff --git a/docs/man/man1/openshift-cli-export.1 b/docs/man/man1/openshift-cli-export.1 index 93bebad2678c..e2f64174b08a 100644 --- a/docs/man/man1/openshift-cli-export.1 +++ b/docs/man/man1/openshift-cli-export.1 @@ -32,7 +32,7 @@ Another use case for export is to create reusable templates for applications. Pa .PP \fB\-\-all\-namespaces\fP=false - If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with \-\-namespace. + If true, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with \-\-namespace. .PP \fB\-\-as\-template\fP="" @@ -40,7 +40,7 @@ Another use case for export is to create reusable templates for applications. Pa .PP \fB\-\-exact\fP=false - Preserve fields that may be cluster specific, such as service clusterIPs or generated names + If true, preserve fields that may be cluster specific, such as service clusterIPs or generated names .PP \fB\-f\fP, \fB\-\-filename\fP=[] diff --git a/docs/man/man1/openshift-cli-extract.1 b/docs/man/man1/openshift-cli-extract.1 index 7cc4e80d74b7..3ffe8b2b2c56 100644 --- a/docs/man/man1/openshift-cli-extract.1 +++ b/docs/man/man1/openshift-cli-extract.1 @@ -25,7 +25,7 @@ You can limit which keys are extracted with the \-\-keys=NAME flag, or set the d .SH OPTIONS .PP \fB\-\-confirm\fP=false - Overwrite files that already exist. + If true, overwrite files that already exist. .PP \fB\-f\fP, \fB\-\-filename\fP=[] diff --git a/docs/man/man1/openshift-cli-idle.1 b/docs/man/man1/openshift-cli-idle.1 index 015af13a5a51..203ccd36b73c 100644 --- a/docs/man/man1/openshift-cli-idle.1 +++ b/docs/man/man1/openshift-cli-idle.1 @@ -25,11 +25,11 @@ Upon receiving network traffic, the services (and any associated routes) will "w .SH OPTIONS .PP \fB\-\-all\fP=false - Select all services in the namespace + if true, select all services in the namespace .PP \fB\-\-all\-namespaces\fP=false - Select services across all namespaces + if true, select services across all namespaces .PP \fB\-\-dry\-run\fP=false diff --git a/docs/man/man1/openshift-cli-new-build.1 b/docs/man/man1/openshift-cli-new-build.1 index 891dc4ceff19..c046c7b6121f 100644 --- a/docs/man/man1/openshift-cli-new-build.1 +++ b/docs/man/man1/openshift-cli-new-build.1 @@ -112,7 +112,7 @@ Once the build configuration is created a new build will be automatically trigge .PP \fB\-\-to\-docker\fP=false - Have the build output push to a Docker repository. + If true, have the build output push to a Docker repository. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-observe.1 b/docs/man/man1/openshift-cli-observe.1 index ef89f140565a..a5fedaa1c3c9 100644 --- a/docs/man/man1/openshift-cli-observe.1 +++ b/docs/man/man1/openshift-cli-observe.1 @@ -102,7 +102,7 @@ Experimental: This command is under active development and may change without no .SH OPTIONS .PP \fB\-\-all\-namespaces\fP=false - If present, list the requested object(s) across all projects. Project in current context is ignored. + If true, list the requested object(s) across all projects. Project in current context is ignored. .PP \fB\-a\fP, \fB\-\-argument\fP="" @@ -130,7 +130,7 @@ Experimental: This command is under active development and may change without no .PP \fB\-\-no\-headers\fP=false - Skip printing information about each event prior to executing the command. + If true, skip printing information about each event prior to executing the command. .PP \fB\-\-object\-env\-var\fP="" @@ -138,7 +138,7 @@ Experimental: This command is under active development and may change without no .PP \fB\-\-once\fP=false - Exit with a status code 0 after all current objects have been processed. + If true, exit with a status code 0 after all current objects have been processed. .PP \fB\-\-output\fP="jsonpath" @@ -146,7 +146,7 @@ Experimental: This command is under active development and may change without no .PP \fB\-\-print\-metrics\-on\-exit\fP=false - On exit write all metrics to stdout. + If true, on exit write all metrics to stdout. .PP \fB\-\-resync\-period\fP=0 diff --git a/docs/man/man1/openshift-cli-policy-can-i.1 b/docs/man/man1/openshift-cli-policy-can-i.1 index 417232392c69..51e95448bc64 100644 --- a/docs/man/man1/openshift-cli-policy-can-i.1 +++ b/docs/man/man1/openshift-cli-policy-can-i.1 @@ -19,7 +19,7 @@ Check whether an action is allowed .SH OPTIONS .PP \fB\-\-all\-namespaces\fP=false - Check the specified action in all namespaces. + If true, check the specified action in all namespaces. .PP \fB\-\-groups\fP=[] @@ -27,15 +27,15 @@ Check whether an action is allowed .PP \fB\-\-ignore\-scopes\fP=false - Disregard any scopes present on this request and evaluate considering full permissions. + If true, disregard any scopes present on this request and evaluate considering full permissions. .PP \fB\-\-list\fP=false - List all the actions you can perform in a namespace, cannot be specified with \-\-all\-namespaces or a VERB RESOURCE + If true, list all the actions you can perform in a namespace, cannot be specified with \-\-all\-namespaces or a VERB RESOURCE .PP \fB\-q\fP, \fB\-\-quiet\fP=false - Suppress output and just return the exit code. + If true, suppress output and just return the exit code. .PP \fB\-\-scopes\fP=[] diff --git a/docs/man/man1/openshift-cli-policy-who-can.1 b/docs/man/man1/openshift-cli-policy-who-can.1 index 9862046bdcba..482fe86a2026 100644 --- a/docs/man/man1/openshift-cli-policy-who-can.1 +++ b/docs/man/man1/openshift-cli-policy-who-can.1 @@ -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 diff --git a/docs/man/man1/openshift-cli-process.1 b/docs/man/man1/openshift-cli-process.1 index 973ca4154b1e..792f3be3c47b 100644 --- a/docs/man/man1/openshift-cli-process.1 +++ b/docs/man/man1/openshift-cli-process.1 @@ -33,7 +33,7 @@ The output of the process command is always a list of one or more resources. You .PP \fB\-o\fP, \fB\-\-output\fP="json" - Output format. One of: describe|json|yaml|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=... + Output format. One of: describe|json|yaml|name|template|templatefile. .PP \fB\-\-output\-version\fP="" @@ -45,15 +45,15 @@ The output of the process command is always a list of one or more resources. You .PP \fB\-\-parameters\fP=false - Do not process but only print available parameters + If true, do not process but only print available parameters .PP \fB\-\-raw\fP=false - If true output the processed template instead of the template's objects. Implied by \-o describe + If true, output the processed template instead of the template's objects. Implied by \-o describe .PP \fB\-t\fP, \fB\-\-template\fP="" - Template string or path to template file to use when \-o=go\-template, \-o=go\-templatefile. The template format is golang templates [ + Template string or path to template file to use when \-o=template or \-o=templatefile. The template format is golang templates [ \[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]] diff --git a/docs/man/man1/openshift-cli-rollback.1 b/docs/man/man1/openshift-cli-rollback.1 index f378c29cb445..112950dc1332 100644 --- a/docs/man/man1/openshift-cli-rollback.1 +++ b/docs/man/man1/openshift-cli-rollback.1 @@ -28,15 +28,15 @@ If you would like to review the outcome of the rollback, pass '\-\-dry\-run' to .SH OPTIONS .PP \fB\-\-change\-scaling\-settings\fP=false - Include the previous deployment's replicationController replica count and selector in the rollback + If true, include the previous deployment's replicationController replica count and selector in the rollback .PP \fB\-\-change\-strategy\fP=false - Include the previous deployment's strategy in the rollback + If true, include the previous deployment's strategy in the rollback .PP \fB\-\-change\-triggers\fP=false - Include the previous deployment's triggers in the rollback + If true, include the previous deployment's triggers in the rollback .PP \fB\-d\fP, \fB\-\-dry\-run\fP=false diff --git a/docs/man/man1/openshift-cli-rollout-latest.1 b/docs/man/man1/openshift-cli-rollout-latest.1 index 741ba9bb08a4..95b5c7e6ceb9 100644 --- a/docs/man/man1/openshift-cli-rollout-latest.1 +++ b/docs/man/man1/openshift-cli-rollout-latest.1 @@ -22,7 +22,7 @@ This command is appropriate for running manual rollouts. If you want full contro .SH OPTIONS .PP \fB\-\-again\fP=false - Deploy the current pod template without updating state from triggers + If true, deploy the current pod template without updating state from triggers .PP \fB\-\-dry\-run\fP=false diff --git a/docs/man/man1/openshift-cli-rsync.1 b/docs/man/man1/openshift-cli-rsync.1 index 18d565e28f2d..f957a28429c6 100644 --- a/docs/man/man1/openshift-cli-rsync.1 +++ b/docs/man/man1/openshift-cli-rsync.1 @@ -30,23 +30,23 @@ If no container is specified, the first container of the pod is used for the cop .PP \fB\-\-delete\fP=false - Delete files not present in source + If true, delete files not present in source .PP \fB\-\-exclude\fP=[] - rsync \- exclude files matching specified pattern + If true, exclude files matching specified pattern .PP \fB\-\-include\fP=[] - rsync \- include files matching specified pattern + If true, include files matching specified pattern .PP \fB\-\-no\-perms\fP=false - rsync \- do not transfer permissions + If true, do not transfer permissions .PP \fB\-\-progress\fP=false - rsync \- show progress during transfer + If true, show progress during transfer .PP \fB\-q\fP, \fB\-\-quiet\fP=false diff --git a/docs/man/man1/openshift-cli-secrets-new-basicauth.1 b/docs/man/man1/openshift-cli-secrets-new-basicauth.1 index 7f032e92dfa4..ded02323a01a 100644 --- a/docs/man/man1/openshift-cli-secrets-new-basicauth.1 +++ b/docs/man/man1/openshift-cli-secrets-new-basicauth.1 @@ -52,7 +52,7 @@ When creating applications, you may have a SCM server that requires basic authen .PP \fB\-\-prompt\fP=false - Prompt for password or token + If true, prompt for password or token .PP \fB\-a\fP, \fB\-\-show\-all\fP=true diff --git a/docs/man/man1/openshift-cli-secrets-new.1 b/docs/man/man1/openshift-cli-secrets-new.1 index 885ed0f87c5d..7fcbb9fdd9ff 100644 --- a/docs/man/man1/openshift-cli-secrets-new.1 +++ b/docs/man/man1/openshift-cli-secrets-new.1 @@ -22,7 +22,7 @@ Key files can be specified using their file path, in which case a default name w .SH OPTIONS .PP \fB\-\-confirm\fP=false - Allow unknown secret types. + If true, allow unknown secret types. .PP \fB\-\-no\-headers\fP=false @@ -41,7 +41,7 @@ Key files can be specified using their file path, in which case a default name w .PP \fB\-q\fP, \fB\-\-quiet\fP=false - Suppress warnings + If true, suppress warnings .PP \fB\-a\fP, \fB\-\-show\-all\fP=true diff --git a/docs/man/man1/openshift-cli-set-build-hook.1 b/docs/man/man1/openshift-cli-set-build-hook.1 index 2eb875b648d2..6fc9a5aaba69 100644 --- a/docs/man/man1/openshift-cli-set-build-hook.1 +++ b/docs/man/man1/openshift-cli-set-build-hook.1 @@ -28,7 +28,7 @@ The command for a build hook may be specified as a shell script (with the \-\-sc .SH OPTIONS .PP \fB\-\-all\fP=false - Select all build configs in the namespace + If true, select all build configs in the namespace .PP \fB\-\-command\fP=false diff --git a/docs/man/man1/openshift-cli-set-build-secret.1 b/docs/man/man1/openshift-cli-set-build-secret.1 index 3fd07732d73e..dedda7bbabee 100644 --- a/docs/man/man1/openshift-cli-set-build-secret.1 +++ b/docs/man/man1/openshift-cli-set-build-secret.1 @@ -28,7 +28,7 @@ A label selector may be specified with the \-\-selector flag to select the build .SH OPTIONS .PP \fB\-\-all\fP=false - Select all build configs in the namespace + If true, select all build configs in the namespace .PP \fB\-f\fP, \fB\-\-filename\fP=[] diff --git a/docs/man/man1/openshift-cli-set-deployment-hook.1 b/docs/man/man1/openshift-cli-set-deployment-hook.1 index eff6deac4002..b5c6c6cd8ed5 100644 --- a/docs/man/man1/openshift-cli-set-deployment-hook.1 +++ b/docs/man/man1/openshift-cli-set-deployment-hook.1 @@ -34,7 +34,7 @@ Each hook can have its own cancellation policy. One of: abort, retry, or ignore. .SH OPTIONS .PP \fB\-\-all\fP=false - Select all deployment configs in the namespace + If true, select all deployment configs in the namespace .PP \fB\-c\fP, \fB\-\-container\fP="" diff --git a/docs/man/man1/openshift-cli-set-env.1 b/docs/man/man1/openshift-cli-set-env.1 index 8d196e4f1382..2f20a2555a62 100644 --- a/docs/man/man1/openshift-cli-set-env.1 +++ b/docs/man/man1/openshift-cli-set-env.1 @@ -25,7 +25,7 @@ If "\-\-env \-" is passed, environment variables can be read from STDIN using th .SH OPTIONS .PP \fB\-\-all\fP=false - Select all resources in the namespace of the specified resource types + If true, select all resources in the namespace of the specified resource types .PP \fB\-c\fP, \fB\-\-containers\fP="*" @@ -45,7 +45,7 @@ If "\-\-env \-" is passed, environment variables can be read from STDIN using th .PP \fB\-\-list\fP=false - Display the environment and any changes in the standard format + If true, display the environment and any changes in the standard format .PP \fB\-\-no\-headers\fP=false @@ -72,7 +72,7 @@ If "\-\-env \-" is passed, environment variables can be read from STDIN using th .PP \fB\-\-resolve\fP=false - Show secret or configmap references when listing variables + If true, show secret or configmap references when listing variables .PP \fB\-\-resource\-version\fP="" diff --git a/docs/man/man1/openshift-cli-set-probe.1 b/docs/man/man1/openshift-cli-set-probe.1 index f5cb585eaf04..a8dde3fde3c0 100644 --- a/docs/man/man1/openshift-cli-set-probe.1 +++ b/docs/man/man1/openshift-cli-set-probe.1 @@ -38,7 +38,7 @@ Containers that take a variable amount of time to start should set generous init .SH OPTIONS .PP \fB\-\-all\fP=false - Select all resources in the namespace of the specified resource types + If true, select all resources in the namespace of the specified resource types .PP \fB\-c\fP, \fB\-\-containers\fP="*" diff --git a/docs/man/man1/openshift-cli-set-route-backends.1 b/docs/man/man1/openshift-cli-set-route-backends.1 index 2e2d5dc618b4..d9f3618b388e 100644 --- a/docs/man/man1/openshift-cli-set-route-backends.1 +++ b/docs/man/man1/openshift-cli-set-route-backends.1 @@ -41,11 +41,11 @@ Not all routers may support multiple or weighted backends. .PP \fB\-\-all\fP=false - Select all resources in the namespace of the specified resource types + If true, select all resources in the namespace of the specified resource types .PP \fB\-\-equal\fP=false - Set the weight of all backends to 100. + If true, set the weight of all backends to 100. .PP \fB\-f\fP, \fB\-\-filename\fP=[] @@ -89,7 +89,7 @@ Not all routers may support multiple or weighted backends. .PP \fB\-\-zero\fP=false - Set the weight of all backends to zero. + If true, set the weight of all backends to zero. .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/docs/man/man1/openshift-cli-set-triggers.1 b/docs/man/man1/openshift-cli-set-triggers.1 index 9a1495173b88..243fad76a23e 100644 --- a/docs/man/man1/openshift-cli-set-triggers.1 +++ b/docs/man/man1/openshift-cli-set-triggers.1 @@ -28,11 +28,11 @@ Build configs support triggering off of image changes, config changes, and webho .SH OPTIONS .PP \fB\-\-all\fP=false - Select all resources in the namespace of the specified resource types + If true, select all resources in the namespace of the specified resource types .PP \fB\-\-auto\fP=false - Enable all triggers, or just the specified trigger + If true, enable all triggers, or just the specified trigger .PP \fB\-c\fP, \fB\-\-containers\fP="" @@ -48,7 +48,7 @@ Build configs support triggering off of image changes, config changes, and webho .PP \fB\-\-from\-github\fP=false - A GitHub webhook \- a secret value will be generated automatically + If true, a GitHub webhook \- a secret value will be generated automatically .PP \fB\-\-from\-image\fP="" @@ -56,15 +56,15 @@ Build configs support triggering off of image changes, config changes, and webho .PP \fB\-\-from\-webhook\fP=false - A generic webhook \- a secret value will be generated automatically + If true, a generic webhook \- a secret value will be generated automatically .PP \fB\-\-from\-webhook\-allow\-env\fP=false - A generic webhook which can provide environment variables \- a secret value will be generated automatically + If true, a generic webhook which can provide environment variables \- a secret value will be generated automatically .PP \fB\-\-manual\fP=false - Set all triggers to manual, or just the specified trigger + If true, set all triggers to manual, or just the specified trigger .PP \fB\-\-no\-headers\fP=false diff --git a/docs/man/man1/openshift-cli-set-volumes.1 b/docs/man/man1/openshift-cli-set-volumes.1 index db429065de88..dedbc0971912 100644 --- a/docs/man/man1/openshift-cli-set-volumes.1 +++ b/docs/man/man1/openshift-cli-set-volumes.1 @@ -45,11 +45,11 @@ For descriptions on other volume types, see .SH OPTIONS .PP \fB\-\-add\fP=false - Add volume and/or volume mounts for containers + If true, add volume and/or volume mounts for containers .PP \fB\-\-all\fP=false - select all resources in the namespace of the specified resource types + If true, select all resources in the namespace of the specified resource types .PP \fB\-\-claim\-class\fP="" @@ -73,7 +73,7 @@ For descriptions on other volume types, see .PP \fB\-\-confirm\fP=false - Confirm that you really want to remove multiple volumes + If true, confirm that you really want to remove multiple volumes .PP \fB\-c\fP, \fB\-\-containers\fP="*" @@ -85,7 +85,7 @@ For descriptions on other volume types, see .PP \fB\-\-list\fP=false - List volumes and volume mounts for containers + If true, list volumes and volume mounts for containers .PP \fB\-m\fP, \fB\-\-mount\-path\fP="" @@ -120,7 +120,7 @@ For descriptions on other volume types, see .PP \fB\-\-remove\fP=false - Remove volume and/or volume mounts for containers + If true, remove volume and/or volume mounts for containers .PP \fB\-\-secret\-name\fP="" diff --git a/docs/man/man1/openshift-cli-status.1 b/docs/man/man1/openshift-cli-status.1 index ce5ef0d90368..6fc515d433a0 100644 --- a/docs/man/man1/openshift-cli-status.1 +++ b/docs/man/man1/openshift-cli-status.1 @@ -25,7 +25,7 @@ You can specify an output format of "\-o dot" to have this command output the ge .SH OPTIONS .PP \fB\-\-all\-namespaces\fP=false - Display status for all namespaces (must have cluster admin) + If true, display status for all namespaces (must have cluster admin) .PP \fB\-o\fP, \fB\-\-output\fP="" diff --git a/docs/man/man1/openshift-cli-tag.1 b/docs/man/man1/openshift-cli-tag.1 index 00e3ad6641c6..d895588a3d1d 100644 --- a/docs/man/man1/openshift-cli-tag.1 +++ b/docs/man/man1/openshift-cli-tag.1 @@ -33,7 +33,7 @@ Pass the \-\-insecure flag if your external registry does not have a valid HTTPS .PP \fB\-\-insecure\fP=false - Set to true if importing the specified Docker image requires HTTP or has a self\-signed certificate. + Set to true if importing the specified Docker image requires HTTP or has a self\-signed certificate. Defaults to false. .PP \fB\-\-reference\fP=false @@ -41,7 +41,7 @@ Pass the \-\-insecure flag if your external registry does not have a valid HTTPS .PP \fB\-\-scheduled\fP=false - Set a Docker image to be periodically imported from a remote repository. + Set a Docker image to be periodically imported from a remote repository. Defaults to false. .PP \fB\-\-source\fP="" diff --git a/docs/man/man1/openshift-cli-volumes.1 b/docs/man/man1/openshift-cli-volumes.1 index ed720e2ad1a7..6a5b26a7d46d 100644 --- a/docs/man/man1/openshift-cli-volumes.1 +++ b/docs/man/man1/openshift-cli-volumes.1 @@ -19,11 +19,11 @@ DEPRECATED: This command has been moved to "openshift cli set volume" .SH OPTIONS .PP \fB\-\-add\fP=false - Add volume and/or volume mounts for containers + If true, add volume and/or volume mounts for containers .PP \fB\-\-all\fP=false - select all resources in the namespace of the specified resource types + If true, select all resources in the namespace of the specified resource types .PP \fB\-\-claim\-class\fP="" @@ -47,7 +47,7 @@ DEPRECATED: This command has been moved to "openshift cli set volume" .PP \fB\-\-confirm\fP=false - Confirm that you really want to remove multiple volumes + If true, confirm that you really want to remove multiple volumes .PP \fB\-c\fP, \fB\-\-containers\fP="*" @@ -59,7 +59,7 @@ DEPRECATED: This command has been moved to "openshift cli set volume" .PP \fB\-\-list\fP=false - List volumes and volume mounts for containers + If true, list volumes and volume mounts for containers .PP \fB\-m\fP, \fB\-\-mount\-path\fP="" @@ -94,7 +94,7 @@ DEPRECATED: This command has been moved to "openshift cli set volume" .PP \fB\-\-remove\fP=false - Remove volume and/or volume mounts for containers + If true, remove volume and/or volume mounts for containers .PP \fB\-\-secret\-name\fP="" diff --git a/docs/man/man1/openshift-cli-whoami.1 b/docs/man/man1/openshift-cli-whoami.1 index dcab90752ce0..49bf7371b5a0 100644 --- a/docs/man/man1/openshift-cli-whoami.1 +++ b/docs/man/man1/openshift-cli-whoami.1 @@ -26,7 +26,7 @@ The default options for this command will return the currently authenticated use .PP \fB\-\-show\-server\fP=false - Print the current server's REST API URL + If true, print the current server's REST API URL .PP \fB\-t\fP, \fB\-\-show\-token\fP=false diff --git a/docs/man/man1/openshift-ex-build-chain.1 b/docs/man/man1/openshift-ex-build-chain.1 index 70d0cfa5e90f..347416b5b40b 100644 --- a/docs/man/man1/openshift-ex-build-chain.1 +++ b/docs/man/man1/openshift-ex-build-chain.1 @@ -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="" diff --git a/docs/man/man1/openshift-ex-diagnostics.1 b/docs/man/man1/openshift-ex-diagnostics.1 index 10658b603c07..35f240e4c3d0 100644 --- a/docs/man/man1/openshift-ex-diagnostics.1 +++ b/docs/man/man1/openshift-ex-diagnostics.1 @@ -63,7 +63,7 @@ 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}" @@ -71,7 +71,7 @@ The available diagnostic names are: AggregatedLogging, AnalyzeLogs, ClusterRegis .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 @@ -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 diff --git a/docs/man/man1/openshift-ex-ipfailover.1 b/docs/man/man1/openshift-ex-ipfailover.1 index 667b00d21a26..bfe4c412d982 100644 --- a/docs/man/man1/openshift-ex-ipfailover.1 +++ b/docs/man/man1/openshift-ex-ipfailover.1 @@ -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="" diff --git a/pkg/bootstrap/docker/up.go b/pkg/bootstrap/docker/up.go index 84c62bcf26f6..65d66690965f 100644 --- a/pkg/bootstrap/docker/up.go +++ b/pkg/bootstrap/docker/up.go @@ -127,22 +127,22 @@ func NewCmdUp(name, fullName string, f *osclientcmd.Factory, out, errout io.Writ } }, } - cmd.Flags().BoolVar(&config.ShouldCreateDockerMachine, "create-machine", false, "Create a Docker machine if one doesn't exist") + cmd.Flags().BoolVar(&config.ShouldCreateDockerMachine, "create-machine", false, "If true, create a Docker machine if one doesn't exist") cmd.Flags().StringVar(&config.DockerMachine, "docker-machine", "", "Specify the Docker machine to use") cmd.Flags().StringVar(&config.ImageVersion, "version", "", "Specify the tag for OpenShift images") cmd.Flags().StringVar(&config.Image, "image", "openshift/origin", "Specify the images to use for OpenShift") - cmd.Flags().BoolVar(&config.SkipRegistryCheck, "skip-registry-check", false, "Skip Docker daemon registry check") + cmd.Flags().BoolVar(&config.SkipRegistryCheck, "skip-registry-check", false, "If true, skip Docker daemon registry check") cmd.Flags().StringVar(&config.PublicHostname, "public-hostname", "", "Public hostname for OpenShift cluster") cmd.Flags().StringVar(&config.RoutingSuffix, "routing-suffix", "", "Default suffix for server routes") - cmd.Flags().BoolVar(&config.UseExistingConfig, "use-existing-config", false, "Use existing configuration if present") + cmd.Flags().BoolVar(&config.UseExistingConfig, "use-existing-config", false, "If true, use existing configuration if present") cmd.Flags().StringVar(&config.HostConfigDir, "host-config-dir", host.DefaultConfigDir, "Directory on Docker host for OpenShift configuration") cmd.Flags().StringVar(&config.HostVolumesDir, "host-volumes-dir", host.DefaultVolumesDir, "Directory on Docker host for OpenShift volumes") cmd.Flags().StringVar(&config.HostDataDir, "host-data-dir", "", "Directory on Docker host for OpenShift data. If not specified, etcd data will not be persisted on the host.") - cmd.Flags().BoolVar(&config.PortForwarding, "forward-ports", config.PortForwarding, "Use Docker port-forwarding to communicate with origin container. Requires 'socat' locally.") + cmd.Flags().BoolVar(&config.PortForwarding, "forward-ports", config.PortForwarding, "If true, use Docker port-forwarding to communicate with origin container. Requires 'socat' locally.") cmd.Flags().IntVar(&config.ServerLogLevel, "server-loglevel", 0, "Log level for OpenShift server") cmd.Flags().StringArrayVarP(&config.Environment, "env", "e", config.Environment, "Specify a key-value pair for an environment variable to set on OpenShift container") - cmd.Flags().BoolVar(&config.ShouldInstallMetrics, "metrics", false, "Install metrics (experimental)") - cmd.Flags().BoolVar(&config.ShouldInstallLogging, "logging", false, "Install logging (experimental)") + cmd.Flags().BoolVar(&config.ShouldInstallMetrics, "metrics", false, "If true, install metrics (experimental)") + cmd.Flags().BoolVar(&config.ShouldInstallLogging, "logging", false, "If true, install logging (experimental)") return cmd } diff --git a/pkg/cmd/admin/diagnostics/diagnostics.go b/pkg/cmd/admin/diagnostics/diagnostics.go index 1f0ca4790bba..e7c177fc111e 100644 --- a/pkg/cmd/admin/diagnostics/diagnostics.go +++ b/pkg/cmd/admin/diagnostics/diagnostics.go @@ -128,10 +128,10 @@ func NewCmdDiagnostics(name string, fullName string, out io.Writer) *cobra.Comma cmd.Flags().StringVar(&o.ClientClusterContext, options.FlagClusterContextName, "", "Client context to use for cluster administrator") cmd.Flags().StringVar(&o.MasterConfigLocation, options.FlagMasterConfigName, "", "Path to master config file (implies --host)") cmd.Flags().StringVar(&o.NodeConfigLocation, options.FlagNodeConfigName, "", "Path to node config file (implies --host)") - cmd.Flags().BoolVar(&o.IsHost, options.FlagIsHostName, false, "Look for systemd and journald units even without master/node config") + cmd.Flags().BoolVar(&o.IsHost, options.FlagIsHostName, false, "If true, look for systemd and journald units even without master/node config") cmd.Flags().StringVar(&o.ImageTemplate.Format, options.FlagImageTemplateName, o.ImageTemplate.Format, "Image template for DiagnosticPod to use in creating a pod") - cmd.Flags().BoolVar(&o.ImageTemplate.Latest, options.FlagLatestImageName, false, "When expanding the image template, use latest version, not release version") - cmd.Flags().BoolVar(&o.PreventModification, options.FlagPreventModificationName, false, "May be set to prevent diagnostics making any changes via the API") + cmd.Flags().BoolVar(&o.ImageTemplate.Latest, options.FlagLatestImageName, false, "If true, when expanding the image template, use latest version, not release version") + cmd.Flags().BoolVar(&o.PreventModification, options.FlagPreventModificationName, false, "If true, may be set to prevent diagnostics making any changes via the API") cmd.Flags().StringVar(&o.NetworkDiagLogDir, options.FlagNetworkDiagLogDir, netutil.NetworkDiagDefaultLogDir, "Path to store network diagnostic results in case of errors") flagtypes.GLog(cmd.Flags()) options.BindLoggerOptionFlags(cmd.Flags(), o.LogOptions, options.RecommendedLoggerOptionFlags()) diff --git a/pkg/cmd/admin/policy/cani.go b/pkg/cmd/admin/policy/cani.go index 1cf17c4b16f9..aca3cddb1329 100644 --- a/pkg/cmd/admin/policy/cani.go +++ b/pkg/cmd/admin/policy/cani.go @@ -71,10 +71,10 @@ func NewCmdCanI(name, fullName string, f *clientcmd.Factory, out io.Writer) *cob }, } - cmd.Flags().BoolVar(&o.AllNamespaces, "all-namespaces", o.AllNamespaces, "Check the specified action in all namespaces.") - cmd.Flags().BoolVar(&o.ListAll, "list", o.ListAll, "List all the actions you can perform in a namespace, cannot be specified with --all-namespaces or a VERB RESOURCE") - cmd.Flags().BoolVarP(&o.Quiet, "quiet", "q", o.Quiet, "Suppress output and just return the exit code.") - cmd.Flags().BoolVar(&o.IgnoreScopes, "ignore-scopes", o.IgnoreScopes, "Disregard any scopes present on this request and evaluate considering full permissions.") + cmd.Flags().BoolVar(&o.AllNamespaces, "all-namespaces", o.AllNamespaces, "If true, check the specified action in all namespaces.") + cmd.Flags().BoolVar(&o.ListAll, "list", o.ListAll, "If true, list all the actions you can perform in a namespace, cannot be specified with --all-namespaces or a VERB RESOURCE") + cmd.Flags().BoolVarP(&o.Quiet, "quiet", "q", o.Quiet, "If true, suppress output and just return the exit code.") + cmd.Flags().BoolVar(&o.IgnoreScopes, "ignore-scopes", o.IgnoreScopes, "If true, disregard any scopes present on this request and evaluate considering full permissions.") cmd.Flags().StringSliceVar(&o.Scopes, "scopes", o.Scopes, "Check the specified action using these scopes. By default, the scopes on the current token will be used.") cmd.Flags().StringVar(&o.User, "user", o.User, "Check the specified action using this user instead of your user.") cmd.Flags().StringSliceVar(&o.Groups, "groups", o.Groups, "Check the specified action using these groups instead of your groups.") diff --git a/pkg/cmd/admin/policy/reconcile_clusterrolebindings.go b/pkg/cmd/admin/policy/reconcile_clusterrolebindings.go index 24e13c91267c..278a589420cd 100644 --- a/pkg/cmd/admin/policy/reconcile_clusterrolebindings.go +++ b/pkg/cmd/admin/policy/reconcile_clusterrolebindings.go @@ -103,8 +103,8 @@ func NewCmdReconcileClusterRoleBindings(name, fullName string, f *clientcmd.Fact }, } - cmd.Flags().BoolVar(&o.Confirmed, "confirm", o.Confirmed, "Specify that cluster role bindings should be modified. Defaults to false, displaying what would be replaced but not actually replacing anything.") - cmd.Flags().BoolVar(&o.Union, "additive-only", o.Union, "Preserves extra subjects in cluster role bindings.") + cmd.Flags().BoolVar(&o.Confirmed, "confirm", o.Confirmed, "If true, specify that cluster role bindings should be modified. Defaults to false, displaying what would be replaced but not actually replacing anything.") + cmd.Flags().BoolVar(&o.Union, "additive-only", o.Union, "If true, preserves extra subjects in cluster role bindings.") cmd.Flags().StringSliceVar(&excludeUsers, "exclude-users", excludeUsers, "Do not add cluster role bindings for these user names.") cmd.Flags().StringSliceVar(&excludeGroups, "exclude-groups", excludeGroups, "Do not add cluster role bindings for these group names.") kcmdutil.AddPrinterFlags(cmd) diff --git a/pkg/cmd/admin/policy/reconcile_clusterroles.go b/pkg/cmd/admin/policy/reconcile_clusterroles.go index b06d12852904..59046e342e1f 100644 --- a/pkg/cmd/admin/policy/reconcile_clusterroles.go +++ b/pkg/cmd/admin/policy/reconcile_clusterroles.go @@ -100,8 +100,8 @@ func NewCmdReconcileClusterRoles(name, fullName string, f *clientcmd.Factory, ou }, } - cmd.Flags().BoolVar(&o.Confirmed, "confirm", o.Confirmed, "Specify that cluster roles should be modified. Defaults to false, displaying what would be replaced but not actually replacing anything.") - cmd.Flags().BoolVar(&o.Union, "additive-only", o.Union, "Preserves modified cluster roles.") + cmd.Flags().BoolVar(&o.Confirmed, "confirm", o.Confirmed, "If true, specify that cluster roles should be modified. Defaults to false, displaying what would be replaced but not actually replacing anything.") + cmd.Flags().BoolVar(&o.Union, "additive-only", o.Union, "If true, preserves modified cluster roles.") kcmdutil.AddPrinterFlags(cmd) cmd.Flags().Lookup("output").DefValue = "yaml" cmd.Flags().Lookup("output").Value.Set("yaml") diff --git a/pkg/cmd/admin/policy/reconcile_sccs.go b/pkg/cmd/admin/policy/reconcile_sccs.go index 6ed1ef7e122e..e36e61f5a8fa 100644 --- a/pkg/cmd/admin/policy/reconcile_sccs.go +++ b/pkg/cmd/admin/policy/reconcile_sccs.go @@ -98,8 +98,8 @@ func NewCmdReconcileSCC(name, fullName string, f *clientcmd.Factory, out io.Writ }, } - cmd.Flags().BoolVar(&o.Confirmed, "confirm", o.Confirmed, "Specify that cluster SCCs should be modified. Defaults to false, displaying what would be replaced but not actually replacing anything.") - cmd.Flags().BoolVar(&o.Union, "additive-only", o.Union, "Preserves extra users, groups, labels and annotations in the SCC as well as existing priorities.") + cmd.Flags().BoolVar(&o.Confirmed, "confirm", o.Confirmed, "If true, specify that cluster SCCs should be modified. Defaults to false, displaying what would be replaced but not actually replacing anything.") + cmd.Flags().BoolVar(&o.Union, "additive-only", o.Union, "If true, preserves extra users, groups, labels and annotations in the SCC as well as existing priorities.") cmd.Flags().StringVar(&o.InfraNamespace, "infrastructure-namespace", o.InfraNamespace, "Name of the infrastructure namespace.") kcmdutil.AddPrinterFlags(cmd) cmd.Flags().Lookup("output").DefValue = "yaml" diff --git a/pkg/cmd/admin/policy/who_can.go b/pkg/cmd/admin/policy/who_can.go index 30383c6fb024..261c83bbc974 100644 --- a/pkg/cmd/admin/policy/who_can.go +++ b/pkg/cmd/admin/policy/who_can.go @@ -55,7 +55,7 @@ func NewCmdWhoCan(name, fullName string, f *clientcmd.Factory, out io.Writer) *c }, } - cmd.Flags().BoolVar(&options.allNamespaces, "all-namespaces", options.allNamespaces, "If present, list who can perform the specified action in all namespaces.") + cmd.Flags().BoolVar(&options.allNamespaces, "all-namespaces", options.allNamespaces, "If true, list who can perform the specified action in all namespaces.") return cmd } diff --git a/pkg/cmd/admin/prune/builds.go b/pkg/cmd/admin/prune/builds.go index 0b1e370aa624..027f791fa176 100644 --- a/pkg/cmd/admin/prune/builds.go +++ b/pkg/cmd/admin/prune/builds.go @@ -71,8 +71,8 @@ func NewCmdPruneBuilds(f *clientcmd.Factory, parentName, name string, out io.Wri }, } - cmd.Flags().BoolVar(&opts.Confirm, "confirm", opts.Confirm, "Specify that build pruning should proceed. Defaults to false, displaying what would be deleted but not actually deleting anything.") - cmd.Flags().BoolVar(&opts.Orphans, "orphans", opts.Orphans, "Prune all builds whose associated BuildConfig no longer exists and whose status is complete, failed, error, or cancelled.") + cmd.Flags().BoolVar(&opts.Confirm, "confirm", opts.Confirm, "If true, specify that build pruning should proceed. Defaults to false, displaying what would be deleted but not actually deleting anything.") + cmd.Flags().BoolVar(&opts.Orphans, "orphans", opts.Orphans, "If true, prune all builds whose associated BuildConfig no longer exists and whose status is complete, failed, error, or cancelled.") cmd.Flags().DurationVar(&opts.KeepYoungerThan, "keep-younger-than", opts.KeepYoungerThan, "Specify the minimum age of a Build for it to be considered a candidate for pruning.") cmd.Flags().IntVar(&opts.KeepComplete, "keep-complete", opts.KeepComplete, "Per BuildConfig, specify the number of builds whose status is complete that will be preserved.") cmd.Flags().IntVar(&opts.KeepFailed, "keep-failed", opts.KeepFailed, "Per BuildConfig, specify the number of builds whose status is failed, error, or cancelled that will be preserved.") diff --git a/pkg/cmd/admin/prune/deployments.go b/pkg/cmd/admin/prune/deployments.go index 2b991a65aede..e91884d7923d 100644 --- a/pkg/cmd/admin/prune/deployments.go +++ b/pkg/cmd/admin/prune/deployments.go @@ -73,8 +73,8 @@ func NewCmdPruneDeployments(f *clientcmd.Factory, parentName, name string, out i }, } - cmd.Flags().BoolVar(&opts.Confirm, "confirm", opts.Confirm, "Specify that deployment pruning should proceed. Defaults to false, displaying what would be deleted but not actually deleting anything.") - cmd.Flags().BoolVar(&opts.Orphans, "orphans", opts.Orphans, "Prune all deployments where the associated DeploymentConfig no longer exists, the status is complete or failed, and the replica size is 0.") + cmd.Flags().BoolVar(&opts.Confirm, "confirm", opts.Confirm, "If true, specify that deployment pruning should proceed. Defaults to false, displaying what would be deleted but not actually deleting anything.") + cmd.Flags().BoolVar(&opts.Orphans, "orphans", opts.Orphans, "If true, prune all deployments where the associated DeploymentConfig no longer exists, the status is complete or failed, and the replica size is 0.") cmd.Flags().DurationVar(&opts.KeepYoungerThan, "keep-younger-than", opts.KeepYoungerThan, "Specify the minimum age of a deployment for it to be considered a candidate for pruning.") cmd.Flags().IntVar(&opts.KeepComplete, "keep-complete", opts.KeepComplete, "Per DeploymentConfig, specify the number of deployments whose status is complete that will be preserved whose replica size is 0.") cmd.Flags().IntVar(&opts.KeepFailed, "keep-failed", opts.KeepFailed, "Per DeploymentConfig, specify the number of deployments whose status is failed that will be preserved whose replica size is 0.") diff --git a/pkg/cmd/admin/prune/images.go b/pkg/cmd/admin/prune/images.go index 71426d15bc57..d879f6d1e7ef 100644 --- a/pkg/cmd/admin/prune/images.go +++ b/pkg/cmd/admin/prune/images.go @@ -111,7 +111,7 @@ func NewCmdPruneImages(f *clientcmd.Factory, parentName, name string, out io.Wri }, } - cmd.Flags().BoolVar(&opts.Confirm, "confirm", opts.Confirm, "Specify that image pruning should proceed. Defaults to false, displaying what would be deleted but not actually deleting anything.") + cmd.Flags().BoolVar(&opts.Confirm, "confirm", opts.Confirm, "If true, specify that image pruning should proceed. Defaults to false, displaying what would be deleted but not actually deleting anything.") cmd.Flags().BoolVar(opts.AllImages, "all", *opts.AllImages, "Include images that were not pushed to the registry but have been mirrored by pullthrough. Requires --registry-url") cmd.Flags().DurationVar(opts.KeepYoungerThan, "keep-younger-than", *opts.KeepYoungerThan, "Specify the minimum age of an image for it to be considered a candidate for pruning.") cmd.Flags().IntVar(opts.KeepTagRevisions, "keep-tag-revisions", *opts.KeepTagRevisions, "Specify the number of image revisions for a tag in an image stream that will be preserved.") diff --git a/pkg/cmd/admin/registry/registry.go b/pkg/cmd/admin/registry/registry.go index 1e3958f5d0dc..dc2ea42691fb 100644 --- a/pkg/cmd/admin/registry/registry.go +++ b/pkg/cmd/admin/registry/registry.go @@ -183,8 +183,8 @@ func NewCmdRegistry(f *clientcmd.Factory, parentName, name string, out, errout i cmd.Flags().StringVar(&cfg.Selector, "selector", cfg.Selector, "Selector used to filter nodes on deployment. Used to run registries on a specific set of nodes.") cmd.Flags().StringVar(&cfg.ServingCertPath, "tls-certificate", cfg.ServingCertPath, "An optional path to a PEM encoded certificate (which may contain the private key) for serving over TLS") cmd.Flags().StringVar(&cfg.ServingKeyPath, "tls-key", cfg.ServingKeyPath, "An optional path to a PEM encoded private key for serving over TLS") - cmd.Flags().BoolVar(&cfg.DaemonSet, "daemonset", cfg.DaemonSet, "Use a daemonset instead of a deployment config.") - cmd.Flags().BoolVar(&cfg.EnforceQuota, "enforce-quota", cfg.EnforceQuota, "If set, the registry will refuse to write blobs if they exceed quota limits") + cmd.Flags().BoolVar(&cfg.DaemonSet, "daemonset", cfg.DaemonSet, "If true, use a daemonset instead of a deployment config.") + cmd.Flags().BoolVar(&cfg.EnforceQuota, "enforce-quota", cfg.EnforceQuota, "If true, the registry will refuse to write blobs if they exceed quota limits") // autocompletion hints cmd.MarkFlagFilename("credentials", "kubeconfig") diff --git a/pkg/cmd/admin/router/router.go b/pkg/cmd/admin/router/router.go index 2d6baa8dfcbc..230acc95f158 100644 --- a/pkg/cmd/admin/router/router.go +++ b/pkg/cmd/admin/router/router.go @@ -261,7 +261,7 @@ func NewCmdRouter(f *clientcmd.Factory, parentName, name string, out, errout io. cmd.Flags().StringVar(&cfg.Ports, "ports", cfg.Ports, "A comma delimited list of ports or port pairs to expose on the router pod. The default is set for HAProxy. Port pairs are applied to the service and to host ports (if specified).") cmd.Flags().Int32Var(&cfg.Replicas, "replicas", cfg.Replicas, "The replication factor of the router; commonly 2 when high availability is desired.") cmd.Flags().StringVar(&cfg.Labels, "labels", cfg.Labels, "A set of labels to uniquely identify the router and its components.") - cmd.Flags().BoolVar(&cfg.SecretsAsEnv, "secrets-as-env", cfg.SecretsAsEnv, "Use environment variables for master secrets.") + cmd.Flags().BoolVar(&cfg.SecretsAsEnv, "secrets-as-env", cfg.SecretsAsEnv, "If true, use environment variables for master secrets.") cmd.Flags().Bool("create", false, "deprecated; this is now the default behavior") cmd.Flags().StringVar(&cfg.Credentials, "credentials", "", "Path to a .kubeconfig file that will contain the credentials the router should use to contact the master.") cmd.Flags().StringVar(&cfg.DefaultCertificate, "default-cert", cfg.DefaultCertificate, "Optional path to a certificate file that be used as the default certificate. The file should contain the cert, key, and any CA certs necessary for the router to serve the certificate.") @@ -270,7 +270,7 @@ func NewCmdRouter(f *clientcmd.Factory, parentName, name string, out, errout io. cmd.Flags().IntVar(&cfg.StatsPort, "stats-port", cfg.StatsPort, "If the underlying router implementation can provide statistics this is a hint to expose it on this port. Specify 0 if you want to turn off exposing the statistics.") cmd.Flags().StringVar(&cfg.StatsPassword, "stats-password", cfg.StatsPassword, "If the underlying router implementation can provide statistics this is the requested password for auth. If not set a password will be generated.") cmd.Flags().StringVar(&cfg.StatsUsername, "stats-user", cfg.StatsUsername, "If the underlying router implementation can provide statistics this is the requested username for auth.") - cmd.Flags().BoolVar(&cfg.ExposeMetrics, "expose-metrics", cfg.ExposeMetrics, "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.") + cmd.Flags().BoolVar(&cfg.ExposeMetrics, "expose-metrics", cfg.ExposeMetrics, "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.") cmd.Flags().StringVar(&cfg.MetricsImage, "metrics-image", cfg.MetricsImage, "If --expose-metrics is specified this is the image to use to run a sidecar container in the pod exposing metrics. If not set and --expose-metrics is true the image will depend on router implementation.") cmd.Flags().BoolVar(&cfg.HostNetwork, "host-network", cfg.HostNetwork, "If true (the default), then use host networking rather than using a separate container network stack.") cmd.Flags().BoolVar(&cfg.HostPorts, "host-ports", cfg.HostPorts, "If true (the default), when not using host networking host ports will be exposed.") diff --git a/pkg/cmd/cli/cmd/debug.go b/pkg/cmd/cli/cmd/debug.go index df6b39598b5e..7fe8881230fa 100644 --- a/pkg/cmd/cli/cmd/debug.go +++ b/pkg/cmd/cli/cmd/debug.go @@ -138,7 +138,7 @@ func NewCmdDebug(fullName string, f *clientcmd.Factory, in io.Reader, out, errou cmd.Flags().String("output-version", "", "Output the formatted object with the given version (default api-version).") cmd.Flags().String("template", "", "Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].") cmd.MarkFlagFilename("template") - cmd.Flags().Bool("no-headers", false, "When using the default output, don't print headers.") + cmd.Flags().Bool("no-headers", false, "If true, when using the default output, don't print headers.") cmd.Flags().MarkHidden("no-headers") cmd.Flags().String("sort-by", "", "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.") cmd.Flags().MarkHidden("sort-by") @@ -150,13 +150,13 @@ func NewCmdDebug(fullName string, f *clientcmd.Factory, in io.Reader, out, errou cmd.Flags().BoolVarP(&options.DisableTTY, "no-tty", "T", false, "Disable pseudo-terminal allocation") cmd.Flags().StringVarP(&options.Attach.ContainerName, "container", "c", "", "Container name; defaults to first container") - cmd.Flags().BoolVar(&options.KeepAnnotations, "keep-annotations", false, "Keep the original pod annotations") - cmd.Flags().BoolVar(&options.KeepLiveness, "keep-liveness", false, "Keep the original pod liveness probes") + cmd.Flags().BoolVar(&options.KeepAnnotations, "keep-annotations", false, "If true, keep the original pod annotations") + cmd.Flags().BoolVar(&options.KeepLiveness, "keep-liveness", false, "If true, keep the original pod liveness probes") cmd.Flags().BoolVar(&options.KeepInitContainers, "keep-init-containers", true, "Run the init containers for the pod. Defaults to true.") - cmd.Flags().BoolVar(&options.KeepReadiness, "keep-readiness", false, "Keep the original pod readiness probes") - cmd.Flags().BoolVar(&options.OneContainer, "one-container", false, "Run only the selected container, remove all others") + cmd.Flags().BoolVar(&options.KeepReadiness, "keep-readiness", false, "If true, keep the original pod readiness probes") + cmd.Flags().BoolVar(&options.OneContainer, "one-container", false, "If true, run only the selected container, remove all others") cmd.Flags().StringVar(&options.NodeName, "node-name", "", "Set a specific node to run on - by default the pod will run on any valid node") - cmd.Flags().BoolVar(&options.AsRoot, "as-root", false, "Try to run the container as the root user") + cmd.Flags().BoolVar(&options.AsRoot, "as-root", false, "If true, try to run the container as the root user") cmd.Flags().Int64Var(&options.AsUser, "as-user", -1, "Try to run the container as a specific user UID (note: admins may limit your ability to use this flag)") cmd.Flags().StringVarP(&options.Filename, "filename", "f", "", "Filename or URL to file to read a template") diff --git a/pkg/cmd/cli/cmd/deploy.go b/pkg/cmd/cli/cmd/deploy.go index f3b0c746349f..d12a61bdd1e3 100644 --- a/pkg/cmd/cli/cmd/deploy.go +++ b/pkg/cmd/cli/cmd/deploy.go @@ -120,14 +120,14 @@ func NewCmdDeploy(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.C }, } - cmd.Flags().BoolVar(&options.deployLatest, "latest", false, "Start a new deployment now.") + cmd.Flags().BoolVar(&options.deployLatest, "latest", false, "If true, start a new deployment now.") cmd.Flags().MarkDeprecated("latest", fmt.Sprintf("use '%s rollout latest' instead", fullName)) - cmd.Flags().BoolVar(&options.retryDeploy, "retry", false, "Retry the latest failed deployment.") - cmd.Flags().BoolVar(&options.cancelDeploy, "cancel", false, "Cancel the in-progress deployment.") + cmd.Flags().BoolVar(&options.retryDeploy, "retry", false, "If true, retry the latest failed deployment.") + cmd.Flags().BoolVar(&options.cancelDeploy, "cancel", false, "If true, cancel the in-progress deployment.") cmd.Flags().MarkDeprecated("cancel", fmt.Sprintf("use '%s rollout cancel' instead", fullName)) - cmd.Flags().BoolVar(&options.enableTriggers, "enable-triggers", false, "Enables all image triggers for the deployment config.") + cmd.Flags().BoolVar(&options.enableTriggers, "enable-triggers", false, "If true, enables all image triggers for the deployment config.") cmd.Flags().MarkDeprecated("enable-triggers", fmt.Sprintf("use '%s set triggers' instead", fullName)) - cmd.Flags().BoolVar(&options.follow, "follow", false, "Follow the logs of a deployment") + cmd.Flags().BoolVar(&options.follow, "follow", false, "If true, follow the logs of a deployment") return cmd } diff --git a/pkg/cmd/cli/cmd/export.go b/pkg/cmd/cli/cmd/export.go index 371fab3aad1b..c8010e7db653 100644 --- a/pkg/cmd/cli/cmd/export.go +++ b/pkg/cmd/cli/cmd/export.go @@ -66,10 +66,10 @@ func NewCmdExport(fullName string, f *clientcmd.Factory, in io.Reader, out io.Wr }, } cmd.Flags().String("as-template", "", "Output a Template object with specified name instead of a List or single object.") - cmd.Flags().Bool("exact", false, "Preserve fields that may be cluster specific, such as service clusterIPs or generated names") + cmd.Flags().Bool("exact", false, "If true, preserve fields that may be cluster specific, such as service clusterIPs or generated names") cmd.Flags().Bool("raw", false, "If true, do not alter the resources in any way after they are loaded.") cmd.Flags().StringP("selector", "l", "", "Selector (label query) to filter on") - cmd.Flags().Bool("all-namespaces", false, "If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.") + cmd.Flags().Bool("all-namespaces", false, "If true, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.") cmd.Flags().StringSliceVarP(&filenames, "filename", "f", filenames, "Filename, directory, or URL to file for the resource to export.") cmd.MarkFlagFilename("filename") cmd.Flags().Bool("all", true, "DEPRECATED: all is ignored, specifying a resource without a name selects all the instances of that resource") diff --git a/pkg/cmd/cli/cmd/extract.go b/pkg/cmd/cli/cmd/extract.go index 76148414acd4..4f2de3a80def 100644 --- a/pkg/cmd/cli/cmd/extract.go +++ b/pkg/cmd/cli/cmd/extract.go @@ -76,7 +76,7 @@ func NewCmdExtract(fullName string, f *clientcmd.Factory, in io.Reader, out, err kcmdutil.CheckErr(err) }, } - cmd.Flags().BoolVar(&options.Overwrite, "confirm", options.Overwrite, "Overwrite files that already exist.") + cmd.Flags().BoolVar(&options.Overwrite, "confirm", options.Overwrite, "If true, overwrite files that already exist.") cmd.Flags().StringVar(&options.TargetDirectory, "to", options.TargetDirectory, "Directory to extract files to.") cmd.Flags().StringSliceVarP(&options.Filenames, "filename", "f", options.Filenames, "Filename, directory, or URL to file to identify to extract the resource.") cmd.MarkFlagFilename("filename") diff --git a/pkg/cmd/cli/cmd/idle.go b/pkg/cmd/cli/cmd/idle.go index ff21a92cb23c..c6fdac26c6aa 100644 --- a/pkg/cmd/cli/cmd/idle.go +++ b/pkg/cmd/cli/cmd/idle.go @@ -74,8 +74,8 @@ func NewCmdIdle(fullName string, f *clientcmd.Factory, out, errOut io.Writer) *c cmd.Flags().BoolVar(&o.dryRun, "dry-run", false, "If true, only print the annotations that would be written, without annotating or idling the relevant objects") cmd.Flags().StringVar(&o.filename, "resource-names-file", o.filename, "file containing list of services whose scalable resources to idle") cmd.Flags().StringVarP(&o.selector, "selector", "l", o.selector, "Selector (label query) to use to select services") - cmd.Flags().BoolVar(&o.all, "all", o.all, "Select all services in the namespace") - cmd.Flags().BoolVar(&o.allNamespaces, "all-namespaces", o.allNamespaces, "Select services across all namespaces") + cmd.Flags().BoolVar(&o.all, "all", o.all, "if true, select all services in the namespace") + cmd.Flags().BoolVar(&o.allNamespaces, "all-namespaces", o.allNamespaces, "if true, select services across all namespaces") cmd.MarkFlagFilename("resource-names-file") // TODO: take the `-o name` argument, and only print out names instead of the summary diff --git a/pkg/cmd/cli/cmd/newbuild.go b/pkg/cmd/cli/cmd/newbuild.go index 55585e8f4069..708af0b3da33 100644 --- a/pkg/cmd/cli/cmd/newbuild.go +++ b/pkg/cmd/cli/cmd/newbuild.go @@ -127,7 +127,7 @@ func NewCmdNewBuild(name, baseName string, f *clientcmd.Factory, in io.Reader, o cmd.Flags().StringSliceVar(&config.Secrets, "build-secret", config.Secrets, "Secret and destination to use as an input for the build.") cmd.Flags().StringVar(&config.Name, "name", "", "Set name to use for generated build artifacts.") cmd.Flags().StringVar(&config.To, "to", "", "Push built images to this image stream tag (or Docker image repository if --to-docker is set).") - cmd.Flags().BoolVar(&config.OutputDocker, "to-docker", false, "Have the build output push to a Docker repository.") + cmd.Flags().BoolVar(&config.OutputDocker, "to-docker", false, "If true, have the build output push to a Docker repository.") cmd.Flags().StringArrayVarP(&config.Environment, "env", "e", config.Environment, "Specify a key-value pair for an environment variable to set into resulting image.") cmd.Flags().Var(&config.Strategy, "strategy", "Specify the build strategy to use if you don't want to detect (docker|pipeline|source).") cmd.Flags().StringVarP(&config.Dockerfile, "dockerfile", "D", "", "Specify the contents of a Dockerfile to build directly, implies --strategy=docker. Pass '-' to read from STDIN.") diff --git a/pkg/cmd/cli/cmd/observe/observe.go b/pkg/cmd/cli/cmd/observe/observe.go index 12d2cc120ebc..ad00a44072ec 100644 --- a/pkg/cmd/cli/cmd/observe/observe.go +++ b/pkg/cmd/cli/cmd/observe/observe.go @@ -189,7 +189,7 @@ func NewCmdObserve(fullName string, f *clientcmd.Factory, out, errOut io.Writer) } // flags controlling what to select - cmd.Flags().BoolVar(&options.allNamespaces, "all-namespaces", false, "If present, list the requested object(s) across all projects. Project in current context is ignored.") + cmd.Flags().BoolVar(&options.allNamespaces, "all-namespaces", false, "If true, list the requested object(s) across all projects. Project in current context is ignored.") // to perform deletion synchronization cmd.Flags().VarP(&options.deleteCommand, "delete", "d", "A command to run when resources are deleted. Specify multiple times to add arguments.") @@ -208,14 +208,14 @@ func NewCmdObserve(fullName string, f *clientcmd.Factory, out, errOut io.Writer) cmd.Flags().IntVar(&options.retryCount, "retry-count", options.retryCount, "The number of times to retry a failing command before continuing.") // control observe program behavior - cmd.Flags().BoolVar(&options.once, "once", false, "Exit with a status code 0 after all current objects have been processed.") + cmd.Flags().BoolVar(&options.once, "once", false, "If true, exit with a status code 0 after all current objects have been processed.") cmd.Flags().DurationVar(&options.exitAfterPeriod, "exit-after", 0, "Exit with status code 0 after the provided duration, optional.") cmd.Flags().DurationVar(&options.resyncPeriod, "resync-period", 0, "When non-zero, periodically reprocess every item from the server as a Sync event. Use to ensure external systems are kept up to date. Requires --names") - cmd.Flags().BoolVar(&options.printMetricsOnExit, "print-metrics-on-exit", false, "On exit write all metrics to stdout.") + cmd.Flags().BoolVar(&options.printMetricsOnExit, "print-metrics-on-exit", false, "If true, on exit write all metrics to stdout.") cmd.Flags().StringVar(&options.listenAddr, "listen-addr", options.listenAddr, "The name of an interface to listen on to expose metrics and health checking.") // additional debug output - cmd.Flags().BoolVar(&options.noHeaders, "no-headers", false, "Skip printing information about each event prior to executing the command.") + cmd.Flags().BoolVar(&options.noHeaders, "no-headers", false, "If true, skip printing information about each event prior to executing the command.") return cmd } diff --git a/pkg/cmd/cli/cmd/process.go b/pkg/cmd/cli/cmd/process.go index 830d4087f070..82c52622aa38 100644 --- a/pkg/cmd/cli/cmd/process.go +++ b/pkg/cmd/cli/cmd/process.go @@ -75,11 +75,11 @@ func NewCmdProcess(fullName string, f *clientcmd.Factory, out, errout io.Writer) cmd.Flags().MarkDeprecated("value", "Use -p, --param instead.") cmd.Flags().MarkHidden("value") cmd.Flags().StringArrayVarP(params, "param", "p", nil, "Specify a key-value pair (eg. -p FOO=BAR) to set/override a parameter value in the template.") - cmd.Flags().BoolP("parameters", "", false, "Do not process but only print available parameters") + cmd.Flags().BoolP("parameters", "", false, "If true, do not process but only print available parameters") cmd.Flags().StringP("labels", "l", "", "Label to set in all resources for this template") cmd.Flags().StringP("output", "o", "json", "Output format. One of: describe|json|yaml|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=...") - cmd.Flags().Bool("raw", false, "If true output the processed template instead of the template's objects. Implied by -o describe") + cmd.Flags().Bool("raw", false, "If true, output the processed template instead of the template's objects. Implied by -o describe") cmd.Flags().String("output-version", "", "Output the formatted object with the given version (default api-version).") cmd.Flags().StringP("template", "t", "", "Template string or path to template file to use when -o=go-template, -o=go-templatefile. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]") diff --git a/pkg/cmd/cli/cmd/rollback.go b/pkg/cmd/cli/cmd/rollback.go index 0e2e4d2740fc..5aab679c8fe1 100644 --- a/pkg/cmd/cli/cmd/rollback.go +++ b/pkg/cmd/cli/cmd/rollback.go @@ -82,9 +82,9 @@ func NewCmdRollback(fullName string, f *clientcmd.Factory, out io.Writer) *cobra }, } - cmd.Flags().BoolVar(&opts.IncludeTriggers, "change-triggers", false, "Include the previous deployment's triggers in the rollback") - cmd.Flags().BoolVar(&opts.IncludeStrategy, "change-strategy", false, "Include the previous deployment's strategy in the rollback") - cmd.Flags().BoolVar(&opts.IncludeScalingSettings, "change-scaling-settings", false, "Include the previous deployment's replicationController replica count and selector in the rollback") + cmd.Flags().BoolVar(&opts.IncludeTriggers, "change-triggers", false, "If true, include the previous deployment's triggers in the rollback") + cmd.Flags().BoolVar(&opts.IncludeStrategy, "change-strategy", false, "If true, include the previous deployment's strategy in the rollback") + cmd.Flags().BoolVar(&opts.IncludeScalingSettings, "change-scaling-settings", false, "If true, include the previous deployment's replicationController replica count and selector in the rollback") cmd.Flags().BoolVarP(&opts.DryRun, "dry-run", "d", false, "Instead of performing the rollback, describe what the rollback will look like in human-readable form") cmd.Flags().StringVarP(&opts.Format, "output", "o", "", "Instead of performing the rollback, print the updated deployment configuration in the specified format (json|yaml|name|template|templatefile)") cmd.Flags().StringVarP(&opts.Template, "template", "t", "", "Template string or path to template file to use when -o=template or -o=templatefile.") diff --git a/pkg/cmd/cli/cmd/rollout/latest.go b/pkg/cmd/cli/cmd/rollout/latest.go index f09c417480b6..c1449d76f0a4 100644 --- a/pkg/cmd/cli/cmd/rollout/latest.go +++ b/pkg/cmd/cli/cmd/rollout/latest.go @@ -78,7 +78,7 @@ func NewCmdRolloutLatest(fullName string, f *clientcmd.Factory, out io.Writer) * kcmdutil.AddPrinterFlags(cmd) kcmdutil.AddDryRunFlag(cmd) - cmd.Flags().Bool("again", false, "Deploy the current pod template without updating state from triggers") + cmd.Flags().Bool("again", false, "If true, deploy the current pod template without updating state from triggers") return cmd } diff --git a/pkg/cmd/cli/cmd/rsync/rsync.go b/pkg/cmd/cli/cmd/rsync/rsync.go index c1cb0770872d..18a064b7f27d 100644 --- a/pkg/cmd/cli/cmd/rsync/rsync.go +++ b/pkg/cmd/cli/cmd/rsync/rsync.go @@ -115,11 +115,11 @@ func NewCmdRsync(name, parent string, f *clientcmd.Factory, out, errOut io.Write // Flags for rsync options, Must match rsync flag names cmd.Flags().BoolVarP(&o.Quiet, "quiet", "q", false, "Suppress non-error messages") - cmd.Flags().BoolVar(&o.Delete, "delete", false, "Delete files not present in source") - cmd.Flags().StringSliceVar(&o.RsyncExclude, "exclude", nil, "rsync - exclude files matching specified pattern") - cmd.Flags().StringSliceVar(&o.RsyncInclude, "include", nil, "rsync - include files matching specified pattern") - cmd.Flags().BoolVar(&o.RsyncProgress, "progress", false, "rsync - show progress during transfer") - cmd.Flags().BoolVar(&o.RsyncNoPerms, "no-perms", false, "rsync - do not transfer permissions") + cmd.Flags().BoolVar(&o.Delete, "delete", false, "If true, delete files not present in source") + cmd.Flags().StringSliceVar(&o.RsyncExclude, "exclude", nil, "If true, exclude files matching specified pattern") + cmd.Flags().StringSliceVar(&o.RsyncInclude, "include", nil, "If true, include files matching specified pattern") + cmd.Flags().BoolVar(&o.RsyncProgress, "progress", false, "If true, show progress during transfer") + cmd.Flags().BoolVar(&o.RsyncNoPerms, "no-perms", false, "If true, do not transfer permissions") cmd.Flags().BoolVarP(&o.Watch, "watch", "w", false, "Watch directory for changes and resync automatically") return cmd } diff --git a/pkg/cmd/cli/cmd/set/buildhook.go b/pkg/cmd/cli/cmd/set/buildhook.go index e76607abb8df..d1f02e3d4a32 100644 --- a/pkg/cmd/cli/cmd/set/buildhook.go +++ b/pkg/cmd/cli/cmd/set/buildhook.go @@ -103,7 +103,7 @@ func NewCmdBuildHook(fullName string, f *clientcmd.Factory, out, errOut io.Write kcmdutil.AddPrinterFlags(cmd) cmd.Flags().StringVarP(&options.Selector, "selector", "l", options.Selector, "Selector (label query) to filter build configs") - cmd.Flags().BoolVar(&options.All, "all", options.All, "Select all build configs in the namespace") + cmd.Flags().BoolVar(&options.All, "all", options.All, "If true, select all build configs in the namespace") cmd.Flags().StringSliceVarP(&options.Filenames, "filename", "f", options.Filenames, "Filename, directory, or URL to file to use to edit the resource.") cmd.Flags().BoolVar(&options.PostCommit, "post-commit", options.PostCommit, "If true, set the post-commit build hook on a build config") diff --git a/pkg/cmd/cli/cmd/set/buildsecret.go b/pkg/cmd/cli/cmd/set/buildsecret.go index 68bab16d1224..56ab51fad966 100644 --- a/pkg/cmd/cli/cmd/set/buildsecret.go +++ b/pkg/cmd/cli/cmd/set/buildsecret.go @@ -101,7 +101,7 @@ func NewCmdBuildSecret(fullName string, f *clientcmd.Factory, out, errOut io.Wri kcmdutil.AddPrinterFlags(cmd) cmd.Flags().StringVarP(&options.Selector, "selector", "l", options.Selector, "Selector (label query) to filter build configs") - cmd.Flags().BoolVar(&options.All, "all", options.All, "Select all build configs in the namespace") + cmd.Flags().BoolVar(&options.All, "all", options.All, "If true, select all build configs in the namespace") cmd.Flags().StringSliceVarP(&options.Filenames, "filename", "f", options.Filenames, "Filename, directory, or URL to file to use to edit the resource.") cmd.Flags().BoolVar(&options.Push, "push", options.Push, "If true, set the push secret on a build config") diff --git a/pkg/cmd/cli/cmd/set/deploymenthook.go b/pkg/cmd/cli/cmd/set/deploymenthook.go index 2c1fdd1eba76..d28c4ed009d1 100644 --- a/pkg/cmd/cli/cmd/set/deploymenthook.go +++ b/pkg/cmd/cli/cmd/set/deploymenthook.go @@ -115,7 +115,7 @@ func NewCmdDeploymentHook(fullName string, f *clientcmd.Factory, out, errOut io. kcmdutil.AddPrinterFlags(cmd) cmd.Flags().StringVarP(&options.Container, "container", "c", options.Container, "The name of the container in the selected deployment config to use for the deployment hook") cmd.Flags().StringVarP(&options.Selector, "selector", "l", options.Selector, "Selector (label query) to filter deployment configs") - cmd.Flags().BoolVar(&options.All, "all", options.All, "Select all deployment configs in the namespace") + cmd.Flags().BoolVar(&options.All, "all", options.All, "If true, select all deployment configs in the namespace") cmd.Flags().StringSliceVarP(&options.Filenames, "filename", "f", options.Filenames, "Filename, directory, or URL to file to use to edit the resource.") cmd.Flags().BoolVar(&options.Remove, "remove", options.Remove, "If true, remove the specified deployment hook(s).") diff --git a/pkg/cmd/cli/cmd/set/env.go b/pkg/cmd/cli/cmd/set/env.go index f3eba6781e9b..90bb5cc7ac92 100644 --- a/pkg/cmd/cli/cmd/set/env.go +++ b/pkg/cmd/cli/cmd/set/env.go @@ -92,10 +92,10 @@ func NewCmdEnv(fullName string, f *clientcmd.Factory, in io.Reader, out, errout cmd.Flags().StringP("from", "", "", "The name of a resource from which to inject environment variables") cmd.Flags().StringP("prefix", "", "", "Prefix to append to variable names") cmd.Flags().StringArrayVarP(&env, "env", "e", env, "Specify a key-value pair for an environment variable to set into each container.") - cmd.Flags().Bool("list", false, "Display the environment and any changes in the standard format") - cmd.Flags().Bool("resolve", false, "Show secret or configmap references when listing variables") + cmd.Flags().Bool("list", false, "If true, display the environment and any changes in the standard format") + cmd.Flags().Bool("resolve", false, "If true, show secret or configmap references when listing variables") cmd.Flags().StringP("selector", "l", "", "Selector (label query) to filter on") - cmd.Flags().Bool("all", false, "Select all resources in the namespace of the specified resource types") + cmd.Flags().Bool("all", false, "If true, select all resources in the namespace of the specified resource types") cmd.Flags().StringSliceVarP(&filenames, "filename", "f", filenames, "Filename, directory, or URL to file to use to edit the resource.") cmd.Flags().Bool("overwrite", true, "If true, allow environment to be overwritten, otherwise reject updates that overwrite existing environment.") cmd.Flags().String("resource-version", "", "If non-empty, the labels update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource.") diff --git a/pkg/cmd/cli/cmd/set/probe.go b/pkg/cmd/cli/cmd/set/probe.go index 3c9ea2664bcf..1b80e2e4d136 100644 --- a/pkg/cmd/cli/cmd/set/probe.go +++ b/pkg/cmd/cli/cmd/set/probe.go @@ -139,7 +139,7 @@ func NewCmdProbe(fullName string, f *clientcmd.Factory, out, errOut io.Writer) * kcmdutil.AddPrinterFlags(cmd) cmd.Flags().StringVarP(&options.ContainerSelector, "containers", "c", options.ContainerSelector, "The names of containers in the selected pod templates to change - may use wildcards") cmd.Flags().StringVarP(&options.Selector, "selector", "l", options.Selector, "Selector (label query) to filter on") - cmd.Flags().BoolVar(&options.All, "all", options.All, "Select all resources in the namespace of the specified resource types") + cmd.Flags().BoolVar(&options.All, "all", options.All, "If true, select all resources in the namespace of the specified resource types") cmd.Flags().StringSliceVarP(&options.Filenames, "filename", "f", options.Filenames, "Filename, directory, or URL to file to use to edit the resource.") cmd.Flags().BoolVar(&options.Remove, "remove", options.Remove, "If true, remove the specified probe(s).") diff --git a/pkg/cmd/cli/cmd/set/routebackends.go b/pkg/cmd/cli/cmd/set/routebackends.go index e523729ceded..6d448c149568 100644 --- a/pkg/cmd/cli/cmd/set/routebackends.go +++ b/pkg/cmd/cli/cmd/set/routebackends.go @@ -117,12 +117,12 @@ func NewCmdRouteBackends(fullName string, f *clientcmd.Factory, out, errOut io.W kcmdutil.AddPrinterFlags(cmd) cmd.Flags().StringVarP(&options.Selector, "selector", "l", options.Selector, "Selector (label query) to filter on") - cmd.Flags().BoolVar(&options.All, "all", options.All, "Select all resources in the namespace of the specified resource types") + cmd.Flags().BoolVar(&options.All, "all", options.All, "If true, select all resources in the namespace of the specified resource types") cmd.Flags().StringSliceVarP(&options.Filenames, "filename", "f", options.Filenames, "Filename, directory, or URL to file to use to edit the resource.") cmd.Flags().BoolVar(&options.Transform.Adjust, "adjust", options.Transform.Adjust, "Adjust a single backend using an absolute or relative weight. If the primary backend is selected and there is more than one alternate an error will be returned.") - cmd.Flags().BoolVar(&options.Transform.Zero, "zero", options.Transform.Zero, "Set the weight of all backends to zero.") - cmd.Flags().BoolVar(&options.Transform.Equal, "equal", options.Transform.Equal, "Set the weight of all backends to 100.") + cmd.Flags().BoolVar(&options.Transform.Zero, "zero", options.Transform.Zero, "If true, set the weight of all backends to zero.") + cmd.Flags().BoolVar(&options.Transform.Equal, "equal", options.Transform.Equal, "If true, set the weight of all backends to 100.") cmd.MarkFlagFilename("filename", "yaml", "yml", "json") diff --git a/pkg/cmd/cli/cmd/set/triggers.go b/pkg/cmd/cli/cmd/set/triggers.go index 42be43ac1f04..136e1932886e 100644 --- a/pkg/cmd/cli/cmd/set/triggers.go +++ b/pkg/cmd/cli/cmd/set/triggers.go @@ -130,20 +130,20 @@ func NewCmdTriggers(fullName string, f *clientcmd.Factory, out, errOut io.Writer kcmdutil.AddPrinterFlags(cmd) cmd.Flags().StringVarP(&options.Selector, "selector", "l", options.Selector, "Selector (label query) to filter on") - cmd.Flags().BoolVar(&options.All, "all", options.All, "Select all resources in the namespace of the specified resource types") + cmd.Flags().BoolVar(&options.All, "all", options.All, "If true, select all resources in the namespace of the specified resource types") cmd.Flags().StringSliceVarP(&options.Filenames, "filename", "f", options.Filenames, "Filename, directory, or URL to file to use to edit the resource.") cmd.Flags().BoolVar(&options.Remove, "remove", options.Remove, "If true, remove the specified trigger(s).") cmd.Flags().BoolVar(&options.RemoveAll, "remove-all", options.RemoveAll, "If true, remove all triggers.") - cmd.Flags().BoolVar(&options.Auto, "auto", options.Auto, "Enable all triggers, or just the specified trigger") - cmd.Flags().BoolVar(&options.Manual, "manual", options.Manual, "Set all triggers to manual, or just the specified trigger") + cmd.Flags().BoolVar(&options.Auto, "auto", options.Auto, "If true, enable all triggers, or just the specified trigger") + cmd.Flags().BoolVar(&options.Manual, "manual", options.Manual, "If true, set all triggers to manual, or just the specified trigger") cmd.Flags().BoolVar(&options.FromConfig, "from-config", options.FromConfig, "If set, configuration changes will result in a change") cmd.Flags().StringVarP(&options.ContainerNames, "containers", "c", options.ContainerNames, "Comma delimited list of container names this trigger applies to on deployments; defaults to the name of the only container") cmd.Flags().StringVar(&options.FromImage, "from-image", options.FromImage, "An image stream tag to trigger off of") - options.FromGitHub = cmd.Flags().Bool("from-github", false, "A GitHub webhook - a secret value will be generated automatically") - options.FromWebHook = cmd.Flags().Bool("from-webhook", false, "A generic webhook - a secret value will be generated automatically") - options.FromWebHookAllowEnv = cmd.Flags().Bool("from-webhook-allow-env", false, "A generic webhook which can provide environment variables - a secret value will be generated automatically") + options.FromGitHub = cmd.Flags().Bool("from-github", false, "If true, a GitHub webhook - a secret value will be generated automatically") + options.FromWebHook = cmd.Flags().Bool("from-webhook", false, "If true, a generic webhook - a secret value will be generated automatically") + options.FromWebHookAllowEnv = cmd.Flags().Bool("from-webhook-allow-env", false, "If true, a generic webhook which can provide environment variables - a secret value will be generated automatically") cmd.MarkFlagFilename("filename", "yaml", "yml", "json") diff --git a/pkg/cmd/cli/cmd/set/volume.go b/pkg/cmd/cli/cmd/set/volume.go index f0463b90c76b..5e59f0d23552 100644 --- a/pkg/cmd/cli/cmd/set/volume.go +++ b/pkg/cmd/cli/cmd/set/volume.go @@ -171,15 +171,15 @@ func NewCmdVolume(fullName string, f *clientcmd.Factory, out, errOut io.Writer) }, } cmd.Flags().StringVarP(&opts.Selector, "selector", "l", "", "Selector (label query) to filter on") - cmd.Flags().BoolVar(&opts.All, "all", false, "select all resources in the namespace of the specified resource types") + cmd.Flags().BoolVar(&opts.All, "all", false, "If true, select all resources in the namespace of the specified resource types") cmd.Flags().StringSliceVarP(&opts.Filenames, "filename", "f", opts.Filenames, "Filename, directory, or URL to file to use to edit the resource.") - cmd.Flags().BoolVar(&opts.Add, "add", false, "Add volume and/or volume mounts for containers") - cmd.Flags().BoolVar(&opts.Remove, "remove", false, "Remove volume and/or volume mounts for containers") - cmd.Flags().BoolVar(&opts.List, "list", false, "List volumes and volume mounts for containers") + cmd.Flags().BoolVar(&opts.Add, "add", false, "If true, add volume and/or volume mounts for containers") + cmd.Flags().BoolVar(&opts.Remove, "remove", false, "If true, remove volume and/or volume mounts for containers") + cmd.Flags().BoolVar(&opts.List, "list", false, "If true, list volumes and volume mounts for containers") cmd.Flags().StringVar(&opts.Name, "name", "", "Name of the volume. If empty, auto generated for add operation") cmd.Flags().StringVarP(&opts.Containers, "containers", "c", "*", "The names of containers in the selected pod templates to change - may use wildcards") - cmd.Flags().BoolVar(&opts.Confirm, "confirm", false, "Confirm that you really want to remove multiple volumes") + cmd.Flags().BoolVar(&opts.Confirm, "confirm", false, "If true, confirm that you really want to remove multiple volumes") cmd.Flags().StringVarP(&addOpts.Type, "type", "t", "", "Type of the volume source for add operation. Supported options: emptyDir, hostPath, secret, configmap, persistentVolumeClaim") cmd.Flags().StringVarP(&addOpts.MountPath, "mount-path", "m", "", "Mount path inside the container. Optional param for --add or --remove") diff --git a/pkg/cmd/cli/cmd/status.go b/pkg/cmd/cli/cmd/status.go index 73593423059a..138c3d7bb527 100644 --- a/pkg/cmd/cli/cmd/status.go +++ b/pkg/cmd/cli/cmd/status.go @@ -83,7 +83,7 @@ func NewCmdStatus(name, baseCLIName, fullName string, f *clientcmd.Factory, out cmd.Flags().StringVarP(&opts.outputFormat, "output", "o", opts.outputFormat, "Output format. One of: dot.") cmd.Flags().BoolVarP(&opts.verbose, "verbose", "v", opts.verbose, "See details for resolving issues.") - cmd.Flags().BoolVar(&opts.allNamespaces, "all-namespaces", false, "Display status for all namespaces (must have cluster admin)") + cmd.Flags().BoolVar(&opts.allNamespaces, "all-namespaces", false, "If true, display status for all namespaces (must have cluster admin)") return cmd } diff --git a/pkg/cmd/cli/cmd/tag.go b/pkg/cmd/cli/cmd/tag.go index 253239f8af26..56d3eb724fe5 100644 --- a/pkg/cmd/cli/cmd/tag.go +++ b/pkg/cmd/cli/cmd/tag.go @@ -89,8 +89,8 @@ func NewCmdTag(fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Comm cmd.Flags().BoolVarP(&opts.deleteTag, "delete", "d", opts.deleteTag, "Delete the provided spec tags") cmd.Flags().BoolVar(&opts.aliasTag, "alias", false, "Should the destination tag be updated whenever the source tag changes. Defaults to false.") cmd.Flags().BoolVar(&opts.referenceTag, "reference", false, "Should the destination tag continue to pull from the source namespace. Defaults to false.") - cmd.Flags().BoolVar(&opts.scheduleTag, "scheduled", false, "Set a Docker image to be periodically imported from a remote repository.") - cmd.Flags().BoolVar(&opts.insecureTag, "insecure", false, "Set to true if importing the specified Docker image requires HTTP or has a self-signed certificate.") + cmd.Flags().BoolVar(&opts.scheduleTag, "scheduled", false, "Set a Docker image to be periodically imported from a remote repository. Defaults to false.") + cmd.Flags().BoolVar(&opts.insecureTag, "insecure", false, "Set to true if importing the specified Docker image requires HTTP or has a self-signed certificate. Defaults to false.") return cmd } diff --git a/pkg/cmd/cli/cmd/whoami.go b/pkg/cmd/cli/cmd/whoami.go index b264ee4fdd89..f2a3e9e57f58 100644 --- a/pkg/cmd/cli/cmd/whoami.go +++ b/pkg/cmd/cli/cmd/whoami.go @@ -53,7 +53,7 @@ func NewCmdWhoAmI(name, fullName string, f *clientcmd.Factory, out io.Writer) *c cmd.Flags().BoolP("show-token", "t", false, "Print the token the current session is using. This will return an error if you are using a different form of authentication.") cmd.Flags().BoolP("show-context", "c", false, "Print the current user context name") - cmd.Flags().Bool("show-server", false, "Print the current server's REST API URL") + cmd.Flags().Bool("show-server", false, "If true, print the current server's REST API URL") return cmd } diff --git a/pkg/cmd/cli/secrets/basicauth.go b/pkg/cmd/cli/secrets/basicauth.go index 691b66cd72be..5ebb9e70c159 100644 --- a/pkg/cmd/cli/secrets/basicauth.go +++ b/pkg/cmd/cli/secrets/basicauth.go @@ -99,7 +99,7 @@ func NewCmdCreateBasicAuthSecret(name, fullName string, f *kcmdutil.Factory, rea cmd.MarkFlagFilename("ca-cert") cmd.Flags().StringVar(&o.GitConfigPath, "gitconfig", "", "Path to a .gitconfig file") cmd.MarkFlagFilename("gitconfig") - cmd.Flags().BoolVarP(&o.PromptForPassword, "prompt", "", false, "Prompt for password or token") + cmd.Flags().BoolVarP(&o.PromptForPassword, "prompt", "", false, "If true, prompt for password or token") kcmdutil.AddPrinterFlags(cmd) diff --git a/pkg/cmd/cli/secrets/new.go b/pkg/cmd/cli/secrets/new.go index d543af4c836c..e260679e3b80 100644 --- a/pkg/cmd/cli/secrets/new.go +++ b/pkg/cmd/cli/secrets/new.go @@ -102,8 +102,8 @@ func NewCmdCreateSecret(name, fullName string, f *clientcmd.Factory, out io.Writ }, } - cmd.Flags().BoolVarP(&options.Quiet, "quiet", "q", options.Quiet, "Suppress warnings") - cmd.Flags().BoolVar(&options.AllowUnknownTypes, "confirm", options.AllowUnknownTypes, "Allow unknown secret types.") + cmd.Flags().BoolVarP(&options.Quiet, "quiet", "q", options.Quiet, "If true, suppress warnings") + cmd.Flags().BoolVar(&options.AllowUnknownTypes, "confirm", options.AllowUnknownTypes, "If true, allow unknown secret types.") cmd.Flags().StringVar(&options.SecretTypeName, "type", "", "The type of secret") kcmdutil.AddPrinterFlags(cmd) diff --git a/pkg/cmd/experimental/buildchain/buildchain.go b/pkg/cmd/experimental/buildchain/buildchain.go index 62b519942e20..c86c6432fb35 100644 --- a/pkg/cmd/experimental/buildchain/buildchain.go +++ b/pkg/cmd/experimental/buildchain/buildchain.go @@ -78,7 +78,7 @@ func NewCmdBuildChain(name, fullName string, f *clientcmd.Factory, out io.Writer }, } - cmd.Flags().BoolVar(&options.allNamespaces, "all", false, "Build dependency tree for the specified image stream tag across all namespaces") + cmd.Flags().BoolVar(&options.allNamespaces, "all", false, "If true, build dependency tree for the specified image stream tag across all namespaces") cmd.Flags().BoolVar(&options.triggerOnly, "trigger-only", true, "If true, only include dependencies based on build triggers. If false, include all dependencies.") cmd.Flags().BoolVar(&options.reverse, "reverse", false, "If true, show the istags dependencies instead of its dependants.") cmd.Flags().StringVarP(&options.output, "output", "o", "", "Output format of dependency tree") diff --git a/pkg/cmd/experimental/ipfailover/ipfailover.go b/pkg/cmd/experimental/ipfailover/ipfailover.go index c861676c5233..c1ab0747ea98 100644 --- a/pkg/cmd/experimental/ipfailover/ipfailover.go +++ b/pkg/cmd/experimental/ipfailover/ipfailover.go @@ -95,7 +95,7 @@ func NewCmdIPFailoverConfig(f *clientcmd.Factory, parentName, name string, out, cmd.Flags().StringVar(&options.Credentials, "credentials", "", "Path to a .kubeconfig file that will contain the credentials the router should use to contact the master.") cmd.Flags().StringVar(&options.ServiceAccount, "service-account", options.ServiceAccount, "Name of the service account to use to run the ipfailover pod.") - cmd.Flags().BoolVar(&options.Create, "create", options.Create, "Create the configuration if it does not exist.") + cmd.Flags().BoolVar(&options.Create, "create", options.Create, "If true, create the configuration if it does not exist.") cmd.Flags().StringVar(&options.VirtualIPs, "virtual-ips", "", "A set of virtual IP ranges and/or addresses that the routers bind and serve on and provide IP failover capability for.") cmd.Flags().StringVar(&options.IptablesChain, "iptables-chain", ipfailover.DefaultIptablesChain, "Add a rule to this iptables chain to accept 224.0.0.28 multicast packets if no rule exists. When iptables-chain is empty do not change iptables.")