Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
DockerCLI/docs/reference/commandline
History
Yong Tang 87b4281f62 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>
 		2017-06-02 00:10:45 +00:00
..
attach.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
build.md correct some words 2017-06-02 00:10:45 +00:00
cli.md Add credential helper documentation 2017-06-02 00:10:43 +00:00
commit.md field NAMES ommitted after docker ps in commit.md 2017-06-02 00:10:45 +00:00
container_prune.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
cp.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
create.md cli: remove `--mount` from `docker run` 2017-06-02 00:10:42 +00:00
deploy.md Fix typo in docs (Copmose) 2017-06-02 00:10:40 +00:00
diff.md Remove redundant parameter and fix typos 2017-06-02 00:10:37 +00:00
docker_images.gif retooling for hugo 2017-06-02 00:06:58 +00:00
dockerd.md Add options for docker plugin enable and fix some typos 2017-06-02 00:10:40 +00:00
events.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
exec.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
export.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
history.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
image_prune.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
images.md Update `images` cli reference with reference filter 2017-06-02 00:10:39 +00:00
import.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
index.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
info.md Update docker info cli reference documentation 2017-06-02 00:10:40 +00:00
inspect.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
kill.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
load.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
login.md Add credential helper documentation 2017-06-02 00:10:43 +00:00
logout.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
logs.md Fix a spelling mistake in the docs. 2017-06-02 00:10:43 +00:00
menu.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
network_connect.md 28600: Docs: network connect for container in Created/Stopped state 2017-06-02 00:10:40 +00:00
network_create.md Add docs for `docker network create --attachable` 2017-06-02 00:10:44 +00:00
network_disconnect.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
network_inspect.md Show peer nodes in network inspect for swarm overlay networks 2017-06-02 00:10:36 +00:00
network_ls.md add SCOPE field content for docker network ls 2017-06-02 00:10:43 +00:00
network_prune.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
network_rm.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
node_demote.md Add the whole related information for node 2017-06-02 00:10:44 +00:00
node_inspect.md Add the whole related information for node 2017-06-02 00:10:44 +00:00
node_ls.md Add the whole related information for node 2017-06-02 00:10:44 +00:00
node_promote.md Add the whole related information for node 2017-06-02 00:10:44 +00:00
node_ps.md Remove `--all|-a` from `docker node ps` reference 2017-06-02 00:10:45 +00:00
node_rm.md Add the whole related information for node 2017-06-02 00:10:44 +00:00
node_update.md Add the whole related information for node 2017-06-02 00:10:44 +00:00
pause.md Fix inconsistency for pause and unpause 2017-06-02 00:10:45 +00:00
plugin_create.md Modify the link for config.json 2017-06-02 00:10:42 +00:00
plugin_disable.md Add docs for plugin push 2017-06-02 00:10:38 +00:00
plugin_enable.md Add options for docker plugin enable and fix some typos 2017-06-02 00:10:40 +00:00
plugin_inspect.md Allow `docker plugin inspect` to search based on ID or name 2017-06-02 00:10:43 +00:00
plugin_install.md Add docs for plugin push 2017-06-02 00:10:38 +00:00
plugin_ls.md Add `ID` field for `docker plugin ls` 2017-06-02 00:10:43 +00:00
plugin_push.md Modify reponame to PLUGIN and fix some typos 2017-06-02 00:10:41 +00:00
plugin_rm.md Add docs for plugin push 2017-06-02 00:10:38 +00:00
plugin_set.md Add docs for plugin push 2017-06-02 00:10:38 +00:00
port.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
ps.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
pull.md Add concurrent uploads/downloads section 2017-06-02 00:10:40 +00:00
push.md Add concurrent uploads/downloads section 2017-06-02 00:10:40 +00:00
rename.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
restart.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
rm.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
rmi.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
run.md cli: remove `--mount` from `docker run` 2017-06-02 00:10:42 +00:00
save.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
search.md Fix copypaste error 'is-automated' 2017-06-02 00:10:42 +00:00
secret_create.md Add `--file` flag for `docker secret create` command 2017-06-02 00:10:45 +00:00
secret_inspect.md Update docs to reflect no longer displaying secret digest or size. 2017-06-02 00:10:40 +00:00
secret_ls.md Fix the inconsistency for docker secret 2017-06-02 00:10:43 +00:00
secret_rm.md support labels for secrets upon creation; review updates 2017-06-02 00:10:36 +00:00
service_create.md Fix misleading default for `--replicas` 2017-06-02 00:10:45 +00:00
service_inspect.md Add the link for service logs 2017-06-02 00:10:44 +00:00
service_logs.md Add the link for service logs 2017-06-02 00:10:44 +00:00
service_ls.md Add the link for service logs 2017-06-02 00:10:44 +00:00
service_ps.md Add the link for service logs 2017-06-02 00:10:44 +00:00
service_rm.md Add the link for service logs 2017-06-02 00:10:44 +00:00
service_scale.md Add the link for service logs 2017-06-02 00:10:44 +00:00
service_update.md Fix misleading default for `--replicas` 2017-06-02 00:10:45 +00:00
stack_deploy.md stack_config.md not exist and delete it 2017-06-02 00:10:44 +00:00
stack_ls.md stack_config.md not exist and delete it 2017-06-02 00:10:44 +00:00
stack_ps.md stack_config.md not exist and delete it 2017-06-02 00:10:44 +00:00
stack_rm.md stack_config.md not exist and delete it 2017-06-02 00:10:44 +00:00
stack_services.md stack_config.md not exist and delete it 2017-06-02 00:10:44 +00:00
start.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
stats.md Update stats cli reference documentation 2017-06-02 00:10:39 +00:00
stop.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
swarm_init.md fix more according to the actual output of 'docker swarm init --help' 2017-06-02 00:10:41 +00:00
swarm_join.md docs: fix description of `docker swarm join --help` 2017-06-02 00:10:44 +00:00
swarm_join_token.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
swarm_leave.md swarm leave is not only for workers 2017-06-02 00:10:45 +00:00
swarm_unlock.md Document autolock/unlock/unlock-key 2017-06-02 00:10:36 +00:00
swarm_unlock_key.md Document autolock/unlock/unlock-key 2017-06-02 00:10:36 +00:00
swarm_update.md docs: fix description of `docker swarm update --help` 2017-06-02 00:10:44 +00:00
system_df.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
system_prune.md Add zsh completion for new prune commands 2017-06-02 00:10:36 +00:00
tag.md Change the docker-tag usage text to be clearer 2017-06-02 00:10:39 +00:00
top.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
unpause.md Fix inconsistency for pause and unpause 2017-06-02 00:10:45 +00:00
update.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
version.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
volume_create.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
volume_inspect.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
volume_ls.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
volume_prune.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
volume_rm.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00
wait.md fix frontmatter keywords value type (string, instead of []string) in /docs/reference 2017-06-02 00:10:31 +00:00