From 7d90a0641739c1bfa42b12ae155120362ba06b8f Mon Sep 17 00:00:00 2001 From: milindchawre Date: Tue, 25 Oct 2016 12:22:07 +0000 Subject: [PATCH] Fixes #24083 : Improving cli help for flags with duration option Signed-off-by: milindchawre --- docs/reference/commandline/create.md | 4 ++-- docs/reference/commandline/run.md | 4 ++-- docs/reference/commandline/service_create.md | 8 ++++---- docs/reference/commandline/service_update.md | 8 ++++---- docs/reference/commandline/swarm_init.md | 4 ++-- docs/reference/commandline/swarm_update.md | 4 ++-- 6 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/reference/commandline/create.md b/docs/reference/commandline/create.md index 034b9dd9..e6621320 100644 --- a/docs/reference/commandline/create.md +++ b/docs/reference/commandline/create.md @@ -58,9 +58,9 @@ Options: --expose value Expose a port or a range of ports (default []) --group-add value Add additional groups to join (default []) --health-cmd string Command to run to check health - --health-interval duration Time between running the check + --health-interval duration Time between running the check (ns|us|ms|s|m|h) (default 0s) --health-retries int Consecutive failures needed to report unhealthy - --health-timeout duration Maximum time to allow one check to run + --health-timeout duration Maximum time to allow one check to run (ns|us|ms|s|m|h) (default 0s) --help Print usage -h, --hostname string Container host name -i, --interactive Keep STDIN open even if not attached diff --git a/docs/reference/commandline/run.md b/docs/reference/commandline/run.md index fc4a9e5a..e89e7710 100644 --- a/docs/reference/commandline/run.md +++ b/docs/reference/commandline/run.md @@ -62,9 +62,9 @@ Options: --expose value Expose a port or a range of ports (default []) --group-add value Add additional groups to join (default []) --health-cmd string Command to run to check health - --health-interval duration Time between running the check + --health-interval duration Time between running the check (ns|us|ms|s|m|h) (default 0s) --health-retries int Consecutive failures needed to report unhealthy - --health-timeout duration Maximum time to allow one check to run + --health-timeout duration Maximum time to allow one check to run (ns|us|ms|s|m|h) (default 0s) --help Print usage -h, --hostname string Container host name -i, --interactive Keep STDIN open even if not attached diff --git a/docs/reference/commandline/service_create.md b/docs/reference/commandline/service_create.md index 4d95ce96..c058616a 100644 --- a/docs/reference/commandline/service_create.md +++ b/docs/reference/commandline/service_create.md @@ -31,9 +31,9 @@ Options: --env-file value Read in a file of environment variables (default []) --group value Set one or more supplementary user groups for the container (default []) --health-cmd string Command to run to check health - --health-interval duration Time between running the check + --health-interval duration Time between running the check (ns|us|ms|s|m|h) (default 0s) --health-retries int Consecutive failures needed to report unhealthy - --health-timeout duration Maximum time to allow one check to run + --health-timeout duration Maximum time to allow one check to run (ns|us|ms|s|m|h) (default 0s) --help Print usage --hostname Service containers hostname -l, --label value Service labels (default []) @@ -56,10 +56,10 @@ Options: --restart-window value Window used to evaluate the restart policy (default none) --stop-grace-period value Time to wait before force killing a container (default none) -t, --tty Allocate a pseudo-TTY - --update-delay duration Delay between updates + --update-delay duration Delay between updates (ns|us|ms|s|m|h) (default 0s) --update-failure-action string Action on update failure (pause|continue) (default "pause") --update-max-failure-ratio value Failure rate to tolerate during an update - --update-monitor duration Duration after each task update to monitor for failure (default 0s) + --update-monitor duration Duration after each task update to monitor for failure (ns|us|ms|s|m|h) (default 0s) --update-parallelism uint Maximum number of tasks updated simultaneously (0 to update all at once) (default 1) -u, --user string Username or UID (format: [:]) --with-registry-auth Send registry authentication details to Swarm agents diff --git a/docs/reference/commandline/service_update.md b/docs/reference/commandline/service_update.md index 531c0009..bf40aa44 100644 --- a/docs/reference/commandline/service_update.md +++ b/docs/reference/commandline/service_update.md @@ -39,9 +39,9 @@ Options: --group-add stringSlice Add an additional supplementary user group to the container --group-rm list Remove a previously added supplementary user group from the container (default []) --health-cmd string Command to run to check health - --health-interval duration-ptr Time between running the check (default none) + --health-interval duration Time between running the check (ns|us|ms|s|m|h) (default 0s) --health-retries int Consecutive failures needed to report unhealthy - --health-timeout duration-ptr Maximum time to allow one check to run (default none) + --health-timeout duration Maximum time to allow one check to run (ns|us|ms|s|m|h) (default 0s) --help Print usage --image string Service image tag --label-add list Add or update a service label (default []) @@ -65,10 +65,10 @@ Options: --rollback Rollback to previous specification --stop-grace-period duration-ptr Time to wait before force killing a container (default none) -t, --tty Allocate a pseudo-TTY - --update-delay duration Delay between updates + --update-delay duration Delay between updates (ns|us|ms|s|m|h) (default 0s) --update-failure-action string Action on update failure (pause|continue) (default "pause") --update-max-failure-ratio float32 Failure rate to tolerate during an update - --update-monitor duration Duration after each task update to monitor for failure + --update-monitor duration Duration after each task update to monitor for failure (ns|us|ms|s|m|h) (default 0s) --update-parallelism uint Maximum number of tasks updated simultaneously (0 to update all at once) (default 1) -u, --user string Username or UID (format: [:]) --with-registry-auth Send registry authentication details to swarm agents diff --git a/docs/reference/commandline/swarm_init.md b/docs/reference/commandline/swarm_init.md index 6c2ab81a..36c07f72 100644 --- a/docs/reference/commandline/swarm_init.md +++ b/docs/reference/commandline/swarm_init.md @@ -22,8 +22,8 @@ Initialize a swarm Options: --advertise-addr value Advertised address (format: [:port]) - --cert-expiry duration Validity period for node certificates (default 2160h0m0s) - --dispatcher-heartbeat duration Dispatcher heartbeat period (default 5s) + --cert-expiry duration Validity period for node certificates (ns|us|ms|s|m|h) (default 2160h0m0s) + --dispatcher-heartbeat duration Dispatcher heartbeat period (ns|us|ms|s|m|h) (default 5s) --external-ca value Specifications of one or more certificate signing endpoints --force-new-cluster Force create a new cluster from current state --help Print usage diff --git a/docs/reference/commandline/swarm_update.md b/docs/reference/commandline/swarm_update.md index 46395cf4..e9c30b6d 100644 --- a/docs/reference/commandline/swarm_update.md +++ b/docs/reference/commandline/swarm_update.md @@ -21,8 +21,8 @@ Usage: docker swarm update [OPTIONS] Update the swarm Options: - --cert-expiry duration Validity period for node certificates (default 2160h0m0s) - --dispatcher-heartbeat duration Dispatcher heartbeat period (default 5s) + --cert-expiry duration Validity period for node certificates (ns|us|ms|s|m|h) (default 2160h0m0s) + --dispatcher-heartbeat duration Dispatcher heartbeat period (ns|us|ms|s|m|h) (default 5s) --external-ca value Specifications of one or more certificate signing endpoints --help Print usage --max-snapshots int Number of additional Raft snapshots to retain