From 96d8037700b9e232d2e1b36cdf3e573e5b421149 Mon Sep 17 00:00:00 2001 From: Yong Tang Date: Tue, 2 Aug 2016 06:58:02 -0700 Subject: [PATCH] Update docs in `docker service create/update` for flag `--user` In `docker service create/update`, flag `--user` actually supports `uid:gid` (same as `docker run`). However, this is not reflected in the help and documentation yet. This fix updates docs in `docker service create/update` to change the description to `Username or UID (format: [:])`. The help message output has also been updated. This fix is related to 25304. Signed-off-by: Yong Tang Upstream-commit: 80a3755a8f9eac577b65c3403bcbb23a120e6585 Component: engine --- components/engine/api/client/service/opts.go | 2 +- components/engine/docs/reference/commandline/service_create.md | 2 +- components/engine/docs/reference/commandline/service_update.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/components/engine/api/client/service/opts.go b/components/engine/api/client/service/opts.go index 9afb307625..ea2e977286 100644 --- a/components/engine/api/client/service/opts.go +++ b/components/engine/api/client/service/opts.go @@ -489,7 +489,7 @@ func addServiceFlags(cmd *cobra.Command, opts *serviceOptions) { flags.StringVar(&opts.name, flagName, "", "Service name") flags.StringVarP(&opts.workdir, flagWorkdir, "w", "", "Working directory inside the container") - flags.StringVarP(&opts.user, flagUser, "u", "", "Username or UID") + flags.StringVarP(&opts.user, flagUser, "u", "", "Username or UID (format: [:])") flags.Var(&opts.resources.limitCPU, flagLimitCPU, "Limit CPUs") flags.Var(&opts.resources.limitMemBytes, flagLimitMemory, "Limit Memory") diff --git a/components/engine/docs/reference/commandline/service_create.md b/components/engine/docs/reference/commandline/service_create.md index 4711b1aee3..164d3d2119 100644 --- a/components/engine/docs/reference/commandline/service_create.md +++ b/components/engine/docs/reference/commandline/service_create.md @@ -42,7 +42,7 @@ Options: --update-delay duration Delay between updates --update-failure-action string Action on update failure (pause|continue) (default "pause") --update-parallelism uint Maximum number of tasks updated simultaneously (0 to update all at once) (default 1) - -u, --user string Username or UID + -u, --user string Username or UID (format: [:]) --with-registry-auth Send registry authentication details to Swarm agents -w, --workdir string Working directory inside the container ``` diff --git a/components/engine/docs/reference/commandline/service_update.md b/components/engine/docs/reference/commandline/service_update.md index dcb0278c39..6d73fb6fd0 100644 --- a/components/engine/docs/reference/commandline/service_update.md +++ b/components/engine/docs/reference/commandline/service_update.md @@ -50,7 +50,7 @@ Options: --update-delay duration Delay between updates --update-failure-action string Action on update failure (pause|continue) (default "pause") --update-parallelism uint Maximum number of tasks updated simultaneously (0 to update all at once) (default 1) - -u, --user string Username or UID + -u, --user string Username or UID (format: [:]) --with-registry-auth Send registry authentication details to Swarm agents -w, --workdir string Working directory inside the container ```