fix --pull documentation

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
docker · Nov 7, 2023 · 2945532 · 2945532
1 parent e5cd265
commit 2945532
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 6 deletions.
diff --git a/cmd/compose/create.go b/cmd/compose/create.go
@@ -74,7 +74,7 @@ func createCommand(p *ProjectOptions, dockerCli command.Cli, backend api.Service
 	flags := cmd.Flags()
 	flags.BoolVar(&opts.Build, "build", false, "Build images before starting containers.")
 	flags.BoolVar(&opts.noBuild, "no-build", false, "Don't build an image, even if it's policy.")
-	flags.StringVar(&opts.Pull, "pull", "policy", `Pull image before running ("always"|"policy"|"never")`)
+	flags.StringVar(&opts.Pull, "pull", "policy", `Pull image before running ("always"|"missing"|"never"|"build")`)
 	flags.BoolVar(&opts.forceRecreate, "force-recreate", false, "Recreate containers even if their configuration and image haven't changed.")
 	flags.BoolVar(&opts.noRecreate, "no-recreate", false, "If containers already exist, don't recreate them. Incompatible with --force-recreate.")
 	flags.BoolVar(&opts.removeOrphans, "remove-orphans", false, "Remove containers for services not defined in the Compose file.")

diff --git a/cmd/compose/up.go b/cmd/compose/up.go
@@ -102,7 +102,7 @@ func upCommand(p *ProjectOptions, dockerCli command.Cli, backend api.Service) *c
 	flags.BoolVarP(&up.Detach, "detach", "d", false, "Detached mode: Run containers in the background")
 	flags.BoolVar(&create.Build, "build", false, "Build images before starting containers.")
 	flags.BoolVar(&create.noBuild, "no-build", false, "Don't build an image, even if it's policy.")
-	flags.StringVar(&create.Pull, "pull", "policy", `Pull image before running ("always"|"policy"|"never")`)
+	flags.StringVar(&create.Pull, "pull", "policy", `Pull image before running ("always"|"missing"|"never")`)
 	flags.BoolVar(&create.removeOrphans, "remove-orphans", false, "Remove containers for services not defined in the Compose file.")
 	flags.StringArrayVar(&create.scale, "scale", []string{}, "Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present.")
 	flags.BoolVar(&up.noColor, "no-color", false, "Produce monochrome output.")

diff --git a/docs/reference/compose_create.md b/docs/reference/compose_create.md
@@ -12,7 +12,7 @@ Creates containers for a service.
 | `--force-recreate` |               |          | Recreate containers even if their configuration and image haven't changed.                    |
 | `--no-build`       |               |          | Don't build an image, even if it's policy.                                                    |
 | `--no-recreate`    |               |          | If containers already exist, don't recreate them. Incompatible with --force-recreate.         |
-| `--pull`           | `string`      | `policy` | Pull image before running ("always"\|"policy"\|"never")                                       |
+| `--pull`           | `string`      | `policy` | Pull image before running ("always"\|"missing"\|"never"\|"build")                             |
 | `--remove-orphans` |               |          | Remove containers for services not defined in the Compose file.                               |
 | `--scale`          | `stringArray` |          | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. |
 

diff --git a/docs/reference/compose_up.md b/docs/reference/compose_up.md
@@ -23,7 +23,7 @@ Create and start containers
 | `--no-log-prefix`            |               |          | Don't print prefix in logs.                                                                              |
 | `--no-recreate`              |               |          | If containers already exist, don't recreate them. Incompatible with --force-recreate.                    |
 | `--no-start`                 |               |          | Don't start the services after creating them.                                                            |
-| `--pull`                     | `string`      | `policy` | Pull image before running ("always"\|"policy"\|"never")                                                  |
+| `--pull`                     | `string`      | `policy` | Pull image before running ("always"\|"missing"\|"never")                                                 |
 | `--quiet-pull`               |               |          | Pull without printing progress information.                                                              |
 | `--remove-orphans`           |               |          | Remove containers for services not defined in the Compose file.                                          |
 | `-V`, `--renew-anon-volumes` |               |          | Recreate anonymous volumes instead of retrieving data from the previous containers.                      |

diff --git a/docs/reference/docker_compose_create.yaml b/docs/reference/docker_compose_create.yaml
@@ -50,7 +50,7 @@ options:
     - option: pull
       value_type: string
       default_value: policy
-      description: Pull image before running ("always"|"policy"|"never")
+      description: Pull image before running ("always"|"missing"|"never"|"build")
       deprecated: false
       hidden: false
       experimental: false

diff --git a/docs/reference/docker_compose_up.yaml b/docs/reference/docker_compose_up.yaml
@@ -182,7 +182,7 @@ options:
     - option: pull
       value_type: string
       default_value: policy
-      description: Pull image before running ("always"|"policy"|"never")
+      description: Pull image before running ("always"|"missing"|"never")
       deprecated: false
       hidden: false
       experimental: false