1berry/docker-cli
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixes #24083 : Improving cli help for flags with duration option

Browse Source 
Signed-off-by: milindchawre <milindchawre@gmail.com>
This commit is contained in:
milindchawre 2016-10-25 12:22:07 +00:00 committed by Tibor Vass
parent 0192ac0265
commit 7d90a06417
6 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/reference/commandline/create.md
View File

@ -58,9 +58,9 @@ Options:
--expose value Expose a port or a range of ports (default []) --expose value Expose a port or a range of ports (default [])
--group-add value Add additional groups to join (default []) --group-add value Add additional groups to join (default [])
--health-cmd string Command to run to check health --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-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 --help Print usage
-h, --hostname string Container host name -h, --hostname string Container host name
-i, --interactive Keep STDIN open even if not attached -i, --interactive Keep STDIN open even if not attached

4
docs/reference/commandline/run.md
View File

@ -62,9 +62,9 @@ Options:
--expose value Expose a port or a range of ports (default []) --expose value Expose a port or a range of ports (default [])
--group-add value Add additional groups to join (default []) --group-add value Add additional groups to join (default [])
--health-cmd string Command to run to check health --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-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 --help Print usage
-h, --hostname string Container host name -h, --hostname string Container host name
-i, --interactive Keep STDIN open even if not attached -i, --interactive Keep STDIN open even if not attached

8
docs/reference/commandline/service_create.md
View File

@ -31,9 +31,9 @@ Options:
--env-file value Read in a file of environment variables (default []) --env-file value Read in a file of environment variables (default [])
--group value Set one or more supplementary user groups for the container (default []) --group value Set one or more supplementary user groups for the container (default [])
--health-cmd string Command to run to check health --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-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 --help Print usage
--hostname Service containers hostname --hostname Service containers hostname
-l, --label value Service labels (default []) -l, --label value Service labels (default [])
@ -56,10 +56,10 @@ Options:
--restart-window value Window used to evaluate the restart policy (default none) --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) --stop-grace-period value Time to wait before force killing a container (default none)
-t, --tty Allocate a pseudo-TTY -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-failure-action string Action on update failure (pause|continue) (default "pause")
--update-max-failure-ratio value Failure rate to tolerate during an update --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) --update-parallelism uint Maximum number of tasks updated simultaneously (0 to update all at once) (default 1)
-u, --user string Username or UID (format: <name|uid>[:<group|gid>]) -u, --user string Username or UID (format: <name|uid>[:<group|gid>])
--with-registry-auth Send registry authentication details to Swarm agents --with-registry-auth Send registry authentication details to Swarm agents

8
docs/reference/commandline/service_update.md
View File

@ -39,9 +39,9 @@ Options:
--group-add stringSlice Add an additional supplementary user group to the container --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 []) --group-rm list Remove a previously added supplementary user group from the container (default [])
--health-cmd string Command to run to check health --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-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 --help Print usage
--image string Service image tag --image string Service image tag
--label-add list Add or update a service label (default []) --label-add list Add or update a service label (default [])
@ -65,10 +65,10 @@ Options:
--rollback Rollback to previous specification --rollback Rollback to previous specification
--stop-grace-period duration-ptr Time to wait before force killing a container (default none) --stop-grace-period duration-ptr Time to wait before force killing a container (default none)
-t, --tty Allocate a pseudo-TTY -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-failure-action string Action on update failure (pause|continue) (default "pause")
--update-max-failure-ratio float32 Failure rate to tolerate during an update --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) --update-parallelism uint Maximum number of tasks updated simultaneously (0 to update all at once) (default 1)
-u, --user string Username or UID (format: <name|uid>[:<group|gid>]) -u, --user string Username or UID (format: <name|uid>[:<group|gid>])
--with-registry-auth Send registry authentication details to swarm agents --with-registry-auth Send registry authentication details to swarm agents

4
docs/reference/commandline/swarm_init.md
View File

@ -22,8 +22,8 @@ Initialize a swarm
Options: Options:
--advertise-addr value Advertised address (format: <ip|interface>[:port]) --advertise-addr value Advertised address (format: <ip|interface>[:port])
--cert-expiry duration Validity period for node certificates (default 2160h0m0s) --cert-expiry duration Validity period for node certificates (ns|us|ms|s|m|h) (default 2160h0m0s)
--dispatcher-heartbeat duration Dispatcher heartbeat period (default 5s) --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 --external-ca value Specifications of one or more certificate signing endpoints
--force-new-cluster Force create a new cluster from current state --force-new-cluster Force create a new cluster from current state
--help Print usage --help Print usage

4
docs/reference/commandline/swarm_update.md
View File

@ -21,8 +21,8 @@ Usage: docker swarm update [OPTIONS]
Update the swarm Update the swarm
Options: Options:
--cert-expiry duration Validity period for node certificates (default 2160h0m0s) --cert-expiry duration Validity period for node certificates (ns|us|ms|s|m|h) (default 2160h0m0s)
--dispatcher-heartbeat duration Dispatcher heartbeat period (default 5s) --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 --external-ca value Specifications of one or more certificate signing endpoints
--help Print usage --help Print usage
--max-snapshots int Number of additional Raft snapshots to retain --max-snapshots int Number of additional Raft snapshots to retain