0ct0pu5/moby
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
moby/docs/reference/commandline
History
Yong Tang acc93db32b Fix misleading default for --replicas 
This fix tries to address the issue raised in 29291 where
the output of `--replicas` in `service create/update`:
```
      --replicas uint                    Number of tasks (default none)
```
is misleading. User might incorrectly assume the number of replicas
would be `0` (`none`) by default, while the actual default is `1`.

The issue comes from the fact that some of the default values are
from daemon and it is not possible for client to find out the default
value.

In this case, it might be better to just simply not displaying `(default none)`.

This fix returns "" for `Uint64Opt` so that `(default none)` is hidden.

In addition to `--replicas`, this fix also changes
`--restart-delay`, `--restart-max-attempts`, `--stop-grace-period`,
`--health-interval`, `--health-timeout`, and `--restart-window`
in a similiar fashion.

New Output:
```
      --health-interval duration         Time between running the check (ns|us|ms|s|m|h)
      --health-timeout duration          Maximum time to allow one check to run (ns|us|ms|s|m|h)
...
      --replicas uint                    Number of tasks
...
      --restart-delay duration           Delay between restart attempts (ns|us|ms|s|m|h)
      --restart-max-attempts uint        Maximum number of restarts before giving up
      --restart-window duration          Window used to evaluate the restart policy (ns|us|ms|s|m|h)
...
      --stop-grace-period duration       Time to wait before force killing a container (ns|us|ms|s|m|h)
```

The docs has been updated. Note the docs for help output of `service create/update`
is out of sync with the current master. This fix replace with the update-to-date
help output.

This fix fixes 29291.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2016-12-19 19:35:05 -08:00
..
attach.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
build.md [docs,man] Fixed typo (#29516) 2016-12-18 19:55:09 -05:00
cli.md Add credential helper documentation 2016-12-07 10:14:28 -08:00
commit.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
container_prune.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
cp.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
create.md cli: remove --mount from docker run 2016-11-26 04:55:28 +00:00
deploy.md Fix typo in docs (Copmose) 2016-11-22 19:09:30 +01:00
diff.md Remove redundant parameter and fix typos 2016-11-10 11:05:31 +08:00
docker_images.gif retooling for hugo 2015-06-15 13:19:38 -07:00
dockerd.md Add options for docker plugin enable and fix some typos 2016-11-25 04:07:06 +08:00
events.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
exec.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
export.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
history.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
image_prune.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
images.md Update images cli reference with reference filter 2016-11-17 15:34:17 +01:00
import.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
index.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
info.md Update docker info cli reference documentation 2016-11-23 17:20:12 +01:00
inspect.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
kill.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
load.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
login.md Add credential helper documentation 2016-12-07 10:14:28 -08:00
logout.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
logs.md Fix a spelling mistake in the docs. 2016-12-04 12:55:00 +00:00
menu.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
network_connect.md 28600: Docs: network connect for container in Created/Stopped state 2016-11-23 20:20:37 +00:00
network_create.md Add docs for docker network create --attachable 2016-12-14 08:39:10 -08:00
network_disconnect.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
network_inspect.md Show peer nodes in network inspect for swarm overlay networks 2016-11-09 13:58:04 -08:00
network_ls.md add SCOPE field content for docker network ls 2016-12-08 17:13:38 +08:00
network_prune.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
network_rm.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
node_demote.md Add the whole related information for node 2016-12-16 22:21:52 +08:00
node_inspect.md Add the whole related information for node 2016-12-16 22:21:52 +08:00
node_ls.md Add the whole related information for node 2016-12-16 22:21:52 +08:00
node_promote.md Add the whole related information for node 2016-12-16 22:21:52 +08:00
node_ps.md Remove --all|-a from docker node ps reference 2016-12-18 06:47:54 -08:00
node_rm.md Add the whole related information for node 2016-12-16 22:21:52 +08:00
node_update.md Add the whole related information for node 2016-12-16 22:21:52 +08:00
pause.md Fix inconsistency for pause and unpause 2016-12-16 17:27:28 +08:00
plugin_create.md Merge pull request #28819 from yuexiao-wang/modify-link 2016-11-29 14:28:32 +01:00
plugin_disable.md Add docs for plugin push 2016-11-14 09:10:21 -08:00
plugin_enable.md Add options for docker plugin enable and fix some typos 2016-11-25 04:07:06 +08:00
plugin_inspect.md Allow docker plugin inspect to search based on ID or name 2016-12-01 10:44:17 -08:00
plugin_install.md Add docs for plugin push 2016-11-14 09:10:21 -08:00
plugin_ls.md Add ID field for docker plugin ls 2016-12-02 13:42:50 -08:00
plugin_push.md Modify reponame to PLUGIN and fix some typos 2016-11-25 23:09:46 +08:00
plugin_rm.md Add docs for plugin push 2016-11-14 09:10:21 -08:00
plugin_set.md Add docs for plugin push 2016-11-14 09:10:21 -08:00
port.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
ps.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
pull.md Add concurrent uploads/downloads section 2016-11-22 21:59:10 +00:00
push.md Add concurrent uploads/downloads section 2016-11-22 21:59:10 +00:00
rename.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
restart.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
rm.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
rmi.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
run.md Merge pull request #28838 from AkihiroSuda/remove-run-mount 2016-11-30 11:56:42 -08:00
save.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
search.md Fix copypaste error 'is-automated' 2016-11-28 10:31:38 -08:00
secret_create.md Add --file flag for docker secret create command 2016-12-13 07:35:45 -08:00
secret_inspect.md Update docs to reflect no longer displaying secret digest or size. 2016-11-22 18:18:56 -05:00
secret_ls.md Fix the inconsistency for docker secret 2016-11-30 17:23:39 +08:00
secret_rm.md support labels for secrets upon creation; review updates 2016-11-09 14:27:45 -05:00
service_create.md Fix misleading default for --replicas 2016-12-19 19:35:05 -08:00
service_inspect.md Add the link for service logs 2016-12-15 17:43:51 +08:00
service_logs.md Add the link for service logs 2016-12-15 17:43:51 +08:00
service_ls.md Add the link for service logs 2016-12-15 17:43:51 +08:00
service_ps.md Add the link for service logs 2016-12-15 17:43:51 +08:00
service_rm.md Add the link for service logs 2016-12-15 17:43:51 +08:00
service_scale.md Add the link for service logs 2016-12-15 17:43:51 +08:00
service_update.md Fix misleading default for --replicas 2016-12-19 19:35:05 -08:00
stack_deploy.md stack_config.md not exist and delete it 2016-12-13 18:06:18 +08:00
stack_ls.md stack_config.md not exist and delete it 2016-12-13 18:06:18 +08:00
stack_ps.md stack_config.md not exist and delete it 2016-12-13 18:06:18 +08:00
stack_rm.md stack_config.md not exist and delete it 2016-12-13 18:06:18 +08:00
stack_services.md stack_config.md not exist and delete it 2016-12-13 18:06:18 +08:00
start.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
stats.md Update stats cli reference documentation 2016-11-16 15:26:29 +01:00
stop.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
swarm_init.md fix more according to the actual output of 'docker swarm init --help' 2016-11-28 18:40:11 +09:00
swarm_join.md docs: fix description of docker swarm join --help 2016-12-11 21:21:48 +09:00
swarm_join_token.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
swarm_leave.md swarm leave is not only for workers 2016-12-16 15:10:20 +01:00
swarm_unlock.md Document autolock/unlock/unlock-key 2016-11-09 16:12:11 -08:00
swarm_unlock_key.md Document autolock/unlock/unlock-key 2016-11-09 16:12:11 -08:00
swarm_update.md docs: fix description of docker swarm update --help 2016-12-11 21:25:40 +09:00
system_df.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
system_prune.md Add zsh completion for new prune commands 2016-11-10 20:51:44 +01:00
tag.md Change the docker-tag usage text to be clearer 2016-11-18 10:34:02 +02:00
top.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
unpause.md Fix inconsistency for pause and unpause 2016-12-16 17:27:28 +08:00
update.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
version.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
volume_create.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
volume_inspect.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
volume_ls.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
volume_prune.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
volume_rm.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00
wait.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2016-11-03 15:48:30 -07:00