chore: actualize --platform and --timeout descriptions

Signed-off-by: Alexey Igrychev <alexey.igrychev@flant.com>
werf · May 25, 2022 · 1f6dec9 · 1f6dec9
1 parent 86d5bea
commit 1f6dec9
Show file tree

Hide file tree

Showing 25 changed files with 49 additions and 26 deletions.
diff --git a/cmd/werf/common/common.go b/cmd/werf/common/common.go
@@ -1434,7 +1434,7 @@ func SetupPlatform(cmdData *CmdData, cmd *cobra.Command) {
 		}
 	}
 
-	cmd.Flags().StringVarP(cmdData.Platform, "platform", "", defaultValue, "Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].")
+	cmd.Flags().StringVarP(cmdData.Platform, "platform", "", defaultValue, "Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT] ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)")
 }
 
 func GetContext() context.Context {

diff --git a/cmd/werf/converge/converge.go b/cmd/werf/converge/converge.go
@@ -158,7 +158,7 @@ werf converge --repo registry.mydomain.com/web --env production`,
 	if err != nil || defaultTimeout == nil {
 		defaultTimeout = new(int64)
 	}
-	cmd.Flags().IntVarP(&cmdData.Timeout, "timeout", "t", int(*defaultTimeout), "Resources tracking timeout in seconds")
+	cmd.Flags().IntVarP(&cmdData.Timeout, "timeout", "t", int(*defaultTimeout), "Resources tracking timeout in seconds ($WERF_TIMEOUT by default)")
 	cmd.Flags().BoolVarP(&cmdData.AutoRollback, "auto-rollback", "R", common.GetBoolEnvironmentDefaultFalse("WERF_AUTO_ROLLBACK"), "Enable auto rollback of the failed release to the previous deployed release version when current deploy process have failed ($WERF_AUTO_ROLLBACK by default)")
 	cmd.Flags().BoolVarP(&cmdData.AutoRollback, "atomic", "", common.GetBoolEnvironmentDefaultFalse("WERF_ATOMIC"), "Enable auto rollback of the failed release to the previous deployed release version when current deploy process have failed ($WERF_ATOMIC by default)")
 

diff --git a/docs/_includes/reference/cli/werf_build.md b/docs/_includes/reference/cli/werf_build.md
@@ -205,7 +205,8 @@ werf build [IMAGE_NAME...] [options]
             Parallel tasks limit, set -1 to remove the limitation (default                          
             $WERF_PARALLEL_TASKS_LIMIT or 5)
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --repo=''
             Container registry storage address (default $WERF_REPO)
       --repo-container-registry=''

diff --git a/docs/_includes/reference/cli/werf_bundle_copy.md b/docs/_includes/reference/cli/werf_bundle_copy.md
@@ -48,7 +48,8 @@ werf bundle copy [options]
       --log-verbose=false
             Enable verbose output (default $WERF_LOG_VERBOSE).
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --repo=''
             Container registry storage address (default $WERF_REPO)
       --skip-tls-verify-registry=false

diff --git a/docs/_includes/reference/cli/werf_bundle_export.md b/docs/_includes/reference/cli/werf_bundle_export.md
@@ -172,7 +172,8 @@ werf bundle export [options]
             Parallel tasks limit, set -1 to remove the limitation (default                          
             $WERF_PARALLEL_TASKS_LIMIT or 5)
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --repo=''
             Container registry storage address (default $WERF_REPO)
       --repo-container-registry=''

diff --git a/docs/_includes/reference/cli/werf_bundle_publish.md b/docs/_includes/reference/cli/werf_bundle_publish.md
@@ -180,7 +180,8 @@ werf bundle publish [options]
             Parallel tasks limit, set -1 to remove the limitation (default                          
             $WERF_PARALLEL_TASKS_LIMIT or 5)
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --repo=''
             Container registry storage address (default $WERF_REPO)
       --repo-container-registry=''

diff --git a/docs/_includes/reference/cli/werf_ci_env.md b/docs/_includes/reference/cli/werf_ci_env.md
@@ -92,7 +92,8 @@ werf ci-env CI_SYSTEM [options]
   -o, --output-file-path=''
             Write to custom file (default $WERF_OUTPUT_FILE_PATH).
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --shell=''
             Set to cmdexe, powershell or use the default behaviour that is compatible with any unix 
             shell (default $WERF_SHELL).

diff --git a/docs/_includes/reference/cli/werf_cleanup.md b/docs/_includes/reference/cli/werf_cleanup.md
@@ -160,7 +160,8 @@ werf cleanup [options]
             Parallel tasks limit, set -1 to remove the limitation (default                          
             $WERF_PARALLEL_TASKS_LIMIT or 5)
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --repo=''
             Container registry storage address (default $WERF_REPO)
       --repo-container-registry=''

diff --git a/docs/_includes/reference/cli/werf_compose_config.md b/docs/_includes/reference/cli/werf_compose_config.md
@@ -195,7 +195,8 @@ werf compose config [IMAGE_NAME...] [options] [--docker-compose-options="OPTIONS
             more info https://werf.io/documentation/advanced/giterminism.html, default              
             $WERF_LOOSE_GITERMINISM)
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --repo=''
             Container registry storage address (default $WERF_REPO)
       --repo-container-registry=''

diff --git a/docs/_includes/reference/cli/werf_compose_down.md b/docs/_includes/reference/cli/werf_compose_down.md
@@ -188,7 +188,8 @@ werf compose down [IMAGE_NAME...] [options] [--docker-compose-options="OPTIONS"]
             more info https://werf.io/documentation/advanced/giterminism.html, default              
             $WERF_LOOSE_GITERMINISM)
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --repo=''
             Container registry storage address (default $WERF_REPO)
       --repo-container-registry=''

diff --git a/docs/_includes/reference/cli/werf_compose_run.md b/docs/_includes/reference/cli/werf_compose_run.md
@@ -185,7 +185,8 @@ werf compose run [IMAGE_NAME...] [options] [--docker-compose-options="OPTIONS"]
             more info https://werf.io/documentation/advanced/giterminism.html, default              
             $WERF_LOOSE_GITERMINISM)
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --repo=''
             Container registry storage address (default $WERF_REPO)
       --repo-container-registry=''

diff --git a/docs/_includes/reference/cli/werf_compose_up.md b/docs/_includes/reference/cli/werf_compose_up.md
@@ -196,7 +196,8 @@ werf compose up [IMAGE_NAME...] [options] [--docker-compose-options="OPTIONS"] [
             more info https://werf.io/documentation/advanced/giterminism.html, default              
             $WERF_LOOSE_GITERMINISM)
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --repo=''
             Container registry storage address (default $WERF_REPO)
       --repo-container-registry=''

diff --git a/docs/_includes/reference/cli/werf_converge.md b/docs/_includes/reference/cli/werf_converge.md
@@ -222,7 +222,8 @@ werf converge --repo registry.mydomain.com/web --env production
             Parallel tasks limit, set -1 to remove the limitation (default                          
             $WERF_PARALLEL_TASKS_LIMIT or 5)
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --release=''
             Use specified Helm release name (default [[ project ]]-[[ env ]] template or            
             deploy.helmRelease custom template from werf.yaml or $WERF_RELEASE)
@@ -329,7 +330,7 @@ werf converge --repo registry.mydomain.com/web --env production
             The same address should be specified for all werf processes that work with a single     
             repo. :local address allows execution of werf processes from a single host only
   -t, --timeout=0
-            Resources tracking timeout in seconds
+            Resources tracking timeout in seconds ($WERF_TIMEOUT by default)
       --tmp-dir=''
             Use specified dir to store tmp files and dirs (default $WERF_TMP_DIR or system tmp dir)
       --use-custom-tag=''

diff --git a/docs/_includes/reference/cli/werf_dismiss.md b/docs/_includes/reference/cli/werf_dismiss.md
@@ -163,7 +163,8 @@ werf dismiss [options]
             Use specified Kubernetes namespace (default [[ project ]]-[[ env ]] template or         
             deploy.namespace custom template from werf.yaml or $WERF_NAMESPACE)
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --release=''
             Use specified Helm release name (default [[ project ]]-[[ env ]] template or            
             deploy.helmRelease custom template from werf.yaml or $WERF_RELEASE)

diff --git a/docs/_includes/reference/cli/werf_export.md b/docs/_includes/reference/cli/werf_export.md
@@ -128,7 +128,8 @@ werf export [IMAGE_NAME...] [options]
             more info https://werf.io/documentation/advanced/giterminism.html, default              
             $WERF_LOOSE_GITERMINISM)
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --repo=''
             Container registry storage address (default $WERF_REPO)
       --repo-container-registry=''

diff --git a/docs/_includes/reference/cli/werf_helm_get_autogenerated_values.md b/docs/_includes/reference/cli/werf_helm_get_autogenerated_values.md
@@ -93,7 +93,8 @@ werf helm get-autogenerated-values [options]
             more info https://werf.io/documentation/advanced/giterminism.html, default              
             $WERF_LOOSE_GITERMINISM)
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --repo=''
             Container registry storage address (default $WERF_REPO)
       --repo-container-registry=''

diff --git a/docs/_includes/reference/cli/werf_host_cleanup.md b/docs/_includes/reference/cli/werf_host_cleanup.md
@@ -93,7 +93,8 @@ werf host cleanup [options]
             more info https://werf.io/documentation/advanced/giterminism.html, default              
             $WERF_LOOSE_GITERMINISM)
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
   -N, --project-name=''
             Set a specific project name (default $WERF_PROJECT_NAME)
       --tmp-dir=''

diff --git a/docs/_includes/reference/cli/werf_host_purge.md b/docs/_includes/reference/cli/werf_host_purge.md
@@ -69,7 +69,8 @@ werf host purge [options]
             more info https://werf.io/documentation/advanced/giterminism.html, default              
             $WERF_LOOSE_GITERMINISM)
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
   -N, --project-name=''
             Set a specific project name (default $WERF_PROJECT_NAME)
   -S, --synchronization=''

diff --git a/docs/_includes/reference/cli/werf_kube_run.md b/docs/_includes/reference/cli/werf_kube_run.md
@@ -152,7 +152,8 @@ werf kube-run [options] [IMAGE_NAME] [-- COMMAND ARG...]
             field (default $WERF_OVERRIDES). %pod_name% and %container_name% will be replaced with  
             names of a created pod and a container.
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --pod=''
             Set created pod name (default $WERF_POD or autogenerated if not specified)
       --repo=''

diff --git a/docs/_includes/reference/cli/werf_managed_images_add.md b/docs/_includes/reference/cli/werf_managed_images_add.md
@@ -112,7 +112,8 @@ werf managed-images add [options]
             more info https://werf.io/documentation/advanced/giterminism.html, default              
             $WERF_LOOSE_GITERMINISM)
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --repo=''
             Container registry storage address (default $WERF_REPO)
       --repo-container-registry=''

diff --git a/docs/_includes/reference/cli/werf_managed_images_ls.md b/docs/_includes/reference/cli/werf_managed_images_ls.md
@@ -112,7 +112,8 @@ werf managed-images ls [options]
             more info https://werf.io/documentation/advanced/giterminism.html, default              
             $WERF_LOOSE_GITERMINISM)
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --repo=''
             Container registry storage address (default $WERF_REPO)
       --repo-container-registry=''

diff --git a/docs/_includes/reference/cli/werf_managed_images_rm.md b/docs/_includes/reference/cli/werf_managed_images_rm.md
@@ -112,7 +112,8 @@ werf managed-images rm [options]
             more info https://werf.io/documentation/advanced/giterminism.html, default              
             $WERF_LOOSE_GITERMINISM)
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --repo=''
             Container registry storage address (default $WERF_REPO)
       --repo-container-registry=''

diff --git a/docs/_includes/reference/cli/werf_purge.md b/docs/_includes/reference/cli/werf_purge.md
@@ -146,7 +146,8 @@ werf purge [options]
             Parallel tasks limit, set -1 to remove the limitation (default                          
             $WERF_PARALLEL_TASKS_LIMIT or 5)
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --repo=''
             Container registry storage address (default $WERF_REPO)
       --repo-container-registry=''

diff --git a/docs/_includes/reference/cli/werf_render.md b/docs/_includes/reference/cli/werf_render.md
@@ -176,7 +176,8 @@ werf render [options]
             Parallel tasks limit, set -1 to remove the limitation (default                          
             $WERF_PARALLEL_TASKS_LIMIT or 5)
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --release=''
             Use specified Helm release name (default [[ project ]]-[[ env ]] template or            
             deploy.helmRelease custom template from werf.yaml or $WERF_RELEASE)

diff --git a/docs/_includes/reference/cli/werf_run.md b/docs/_includes/reference/cli/werf_run.md
@@ -140,7 +140,8 @@ werf run [options] [IMAGE_NAME] [-- COMMAND ARG...]
             more info https://werf.io/documentation/advanced/giterminism.html, default              
             $WERF_LOOSE_GITERMINISM)
       --platform=''
-            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT].
+            Enable platform emulation when building images with werf, format: OS/ARCH[/VARIANT]     
+            ($WERF_PLATFORM or $DOCKER_DEFAULT_PLATFORM by default)
       --repo=''
             Container registry storage address (default $WERF_REPO)
       --repo-container-registry=''