diff --git a/docs/reference/docker_compose.yaml b/docs/reference/docker_compose.yaml index 08ea21a53..2cf5cde6c 100644 --- a/docs/reference/docker_compose.yaml +++ b/docs/reference/docker_compose.yaml @@ -163,6 +163,7 @@ options: description: | Control when to print ANSI control characters ("never"|"always"|"auto") deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -172,6 +173,7 @@ options: default_value: "false" description: Run compose in backward compatibility mode deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -180,6 +182,7 @@ options: value_type: string description: Specify an alternate environment file. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -190,6 +193,7 @@ options: default_value: '[]' description: Compose configuration files deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -199,6 +203,7 @@ options: default_value: "false" description: Do not print ANSI control characters (DEPRECATED) deprecated: false + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -208,6 +213,7 @@ options: default_value: '[]' description: Specify a profile to enable deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -218,6 +224,7 @@ options: Specify an alternate working directory (default: the path of the Compose file) deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -227,6 +234,7 @@ options: value_type: string description: Project name deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -236,6 +244,7 @@ options: default_value: "false" description: Show more output deprecated: false + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -246,6 +255,7 @@ options: default_value: "false" description: Show the Docker Compose version information deprecated: false + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -257,6 +267,7 @@ options: Specify an alternate working directory (default: the path of the Compose file) deprecated: false + hidden: true experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_build.yaml b/docs/reference/docker_compose_build.yaml index 5a2715733..8e14e303f 100644 --- a/docs/reference/docker_compose_build.yaml +++ b/docs/reference/docker_compose_build.yaml @@ -19,6 +19,7 @@ options: default_value: '[]' description: Set build-time variables for services. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -28,6 +29,7 @@ options: default_value: "true" description: Compress the build context using gzip. DEPRECATED deprecated: false + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -37,6 +39,7 @@ options: default_value: "true" description: Always remove intermediate containers. DEPRECATED deprecated: false + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -47,6 +50,7 @@ options: description: | Set memory limit for the build container. Not supported on buildkit yet. deprecated: false + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -56,6 +60,7 @@ options: default_value: "false" description: Do not use cache when building the image deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -66,6 +71,7 @@ options: description: | Do not remove intermediate containers after a successful build. DEPRECATED deprecated: false + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -75,6 +81,7 @@ options: default_value: "true" description: Build images in parallel. DEPRECATED deprecated: false + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -84,6 +91,7 @@ options: default_value: auto description: Set type of progress output (auto, tty, plain, quiet) deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -93,6 +101,7 @@ options: default_value: "false" description: Always attempt to pull a newer version of the image. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -103,6 +112,7 @@ options: default_value: "false" description: Don't print anything to STDOUT deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_convert.yaml b/docs/reference/docker_compose_convert.yaml index b2b5da2f2..2c23e2e04 100644 --- a/docs/reference/docker_compose_convert.yaml +++ b/docs/reference/docker_compose_convert.yaml @@ -16,6 +16,7 @@ options: default_value: yaml description: 'Format the output. Values: [yaml | json]' deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -24,6 +25,7 @@ options: value_type: string description: Print the service config hash, one per line. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -33,6 +35,7 @@ options: default_value: "false" description: Print the image names, one per line. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -42,6 +45,7 @@ options: default_value: "false" description: Don't interpolate environment variables. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -51,6 +55,7 @@ options: default_value: "false" description: Don't normalize compose model. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -60,6 +65,7 @@ options: value_type: string description: Save to file (default to stdout) deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -69,6 +75,7 @@ options: default_value: "false" description: Print the profile names, one per line. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -79,6 +86,7 @@ options: default_value: "false" description: Only validate the configuration, don't print anything. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -88,6 +96,7 @@ options: default_value: "false" description: Pin image tags to digests. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -97,6 +106,7 @@ options: default_value: "false" description: Print the service names, one per line. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -106,6 +116,7 @@ options: default_value: "false" description: Print the volume names, one per line. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_cp.yaml b/docs/reference/docker_compose_cp.yaml index 3382d65b4..461f9a5dc 100644 --- a/docs/reference/docker_compose_cp.yaml +++ b/docs/reference/docker_compose_cp.yaml @@ -11,6 +11,7 @@ options: default_value: "false" description: Copy to all the containers of the service. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -21,6 +22,7 @@ options: default_value: "false" description: Archive mode (copy all uid/gid information) deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -31,6 +33,7 @@ options: default_value: "false" description: Always follow symbol link in SRC_PATH deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -41,6 +44,7 @@ options: description: | Index of the container if there are multiple instances of a service [default: 1]. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_create.yaml b/docs/reference/docker_compose_create.yaml index 1372b445f..f71ea7b7a 100644 --- a/docs/reference/docker_compose_create.yaml +++ b/docs/reference/docker_compose_create.yaml @@ -10,6 +10,7 @@ options: default_value: "false" description: Build images before starting containers. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -20,6 +21,7 @@ options: description: | Recreate containers even if their configuration and image haven't changed. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -29,6 +31,7 @@ options: default_value: "false" description: Don't build an image, even if it's missing. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -39,6 +42,7 @@ options: description: | If containers already exist, don't recreate them. Incompatible with --force-recreate. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_down.yaml b/docs/reference/docker_compose_down.yaml index c5046a1eb..95ed4c1f0 100644 --- a/docs/reference/docker_compose_down.yaml +++ b/docs/reference/docker_compose_down.yaml @@ -23,6 +23,7 @@ options: default_value: "false" description: Remove containers for services not defined in the Compose file. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -32,6 +33,7 @@ options: description: | Remove images used by services. "local" remove only images that don't have a custom tag ("local"|"all") deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -42,6 +44,7 @@ options: default_value: "10" description: Specify a shutdown timeout in seconds deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -53,6 +56,7 @@ options: description: | Remove named volumes declared in the `volumes` section of the Compose file and anonymous volumes attached to containers. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_events.yaml b/docs/reference/docker_compose_events.yaml index abe27ff1a..1f0f8250f 100644 --- a/docs/reference/docker_compose_events.yaml +++ b/docs/reference/docker_compose_events.yaml @@ -29,6 +29,7 @@ options: default_value: "false" description: Output events as a stream of json objects deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_exec.yaml b/docs/reference/docker_compose_exec.yaml index 23922090c..061913bdc 100644 --- a/docs/reference/docker_compose_exec.yaml +++ b/docs/reference/docker_compose_exec.yaml @@ -15,6 +15,7 @@ options: default_value: "false" description: 'Detached mode: Run command in the background.' deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -25,6 +26,7 @@ options: default_value: '[]' description: Set environment variables deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -35,6 +37,7 @@ options: description: | index of the container if there are multiple instances of a service [default: 1]. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -45,6 +48,7 @@ options: default_value: "true" description: Keep STDIN open even if not attached. DEPRECATED deprecated: false + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -56,6 +60,7 @@ options: description: | Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -65,6 +70,7 @@ options: default_value: "false" description: Give extended privileges to the process. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -75,6 +81,7 @@ options: default_value: "true" description: Allocate a pseudo-TTY. DEPRECATED deprecated: false + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -84,6 +91,7 @@ options: value_type: string description: Run the command as this user. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -93,6 +101,7 @@ options: value_type: string description: Path to workdir directory for this command. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_images.yaml b/docs/reference/docker_compose_images.yaml index de815e8e9..8e263aef2 100644 --- a/docs/reference/docker_compose_images.yaml +++ b/docs/reference/docker_compose_images.yaml @@ -11,6 +11,7 @@ options: default_value: "false" description: Only display IDs deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_kill.yaml b/docs/reference/docker_compose_kill.yaml index 2640d71b1..f93347828 100644 --- a/docs/reference/docker_compose_kill.yaml +++ b/docs/reference/docker_compose_kill.yaml @@ -16,6 +16,7 @@ options: default_value: SIGKILL description: SIGNAL to send to the container. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_logs.yaml b/docs/reference/docker_compose_logs.yaml index c7fddc9f5..2846bacce 100644 --- a/docs/reference/docker_compose_logs.yaml +++ b/docs/reference/docker_compose_logs.yaml @@ -11,6 +11,7 @@ options: default_value: "false" description: Follow log output. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -20,6 +21,7 @@ options: default_value: "false" description: Produce monochrome output. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -29,6 +31,7 @@ options: default_value: "false" description: Don't print prefix in logs. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -38,6 +41,7 @@ options: description: | Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -48,6 +52,7 @@ options: description: | Number of lines to show from the end of the logs for each container. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -58,6 +63,7 @@ options: default_value: "false" description: Show timestamps. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -67,6 +73,7 @@ options: description: | Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_ls.yaml b/docs/reference/docker_compose_ls.yaml index 305084f98..97ce1364e 100644 --- a/docs/reference/docker_compose_ls.yaml +++ b/docs/reference/docker_compose_ls.yaml @@ -11,6 +11,7 @@ options: default_value: "false" description: Show all stopped Compose projects deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -19,6 +20,7 @@ options: value_type: filter description: Filter output based on conditions provided. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -28,6 +30,7 @@ options: default_value: pretty description: 'Format the output. Values: [pretty | json].' deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -38,6 +41,7 @@ options: default_value: "false" description: Only display IDs. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_port.yaml b/docs/reference/docker_compose_port.yaml index 04b9f4a06..739d3d7ea 100644 --- a/docs/reference/docker_compose_port.yaml +++ b/docs/reference/docker_compose_port.yaml @@ -10,6 +10,7 @@ options: default_value: "1" description: index of the container if service has multiple replicas deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -19,6 +20,7 @@ options: default_value: tcp description: tcp or udp deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_ps.yaml b/docs/reference/docker_compose_ps.yaml index 554f36a59..6ac69b43e 100644 --- a/docs/reference/docker_compose_ps.yaml +++ b/docs/reference/docker_compose_ps.yaml @@ -20,6 +20,7 @@ options: description: | Show all stopped containers (including those created by the run command) deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -28,6 +29,7 @@ options: value_type: string description: Filter services by a property. Deprecated, use --status instead deprecated: false + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -37,6 +39,7 @@ options: default_value: pretty description: 'Format the output. Values: [pretty | json]' deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -47,6 +50,7 @@ options: default_value: "false" description: Only display IDs deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -56,6 +60,7 @@ options: default_value: "false" description: Display services deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -66,6 +71,7 @@ options: description: | Filter services by status. Values: [paused | restarting | removing | running | dead | created | exited] deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_pull.yaml b/docs/reference/docker_compose_pull.yaml index c4e13251f..c7da031ee 100644 --- a/docs/reference/docker_compose_pull.yaml +++ b/docs/reference/docker_compose_pull.yaml @@ -12,6 +12,7 @@ options: default_value: "false" description: Pull what it can and ignores images with pull failures deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -21,6 +22,7 @@ options: default_value: "false" description: Also pull services declared as dependencies deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -30,6 +32,7 @@ options: default_value: "true" description: DEPRECATED disable parallel pulling. deprecated: false + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -39,6 +42,7 @@ options: default_value: "true" description: DEPRECATED pull multiple images in parallel. deprecated: false + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -49,6 +53,7 @@ options: default_value: "false" description: Pull without printing progress information deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_push.yaml b/docs/reference/docker_compose_push.yaml index e81694ade..f006ad615 100644 --- a/docs/reference/docker_compose_push.yaml +++ b/docs/reference/docker_compose_push.yaml @@ -28,6 +28,7 @@ options: default_value: "false" description: Push what it can and ignores images with push failures deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_restart.yaml b/docs/reference/docker_compose_restart.yaml index 689907fa0..e94596c74 100644 --- a/docs/reference/docker_compose_restart.yaml +++ b/docs/reference/docker_compose_restart.yaml @@ -11,6 +11,7 @@ options: default_value: "10" description: Specify a shutdown timeout in seconds deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_rm.yaml b/docs/reference/docker_compose_rm.yaml index 62dd17a67..48108dcdc 100644 --- a/docs/reference/docker_compose_rm.yaml +++ b/docs/reference/docker_compose_rm.yaml @@ -26,6 +26,7 @@ options: default_value: "false" description: Deprecated - no effect deprecated: false + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -36,6 +37,7 @@ options: default_value: "false" description: Don't ask to confirm removal deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -46,6 +48,7 @@ options: default_value: "false" description: Stop the containers, if required, before removing deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -56,6 +59,7 @@ options: default_value: "false" description: Remove any anonymous volumes attached to containers deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_run.yaml b/docs/reference/docker_compose_run.yaml index f2f3af6af..c2cc4f706 100644 --- a/docs/reference/docker_compose_run.yaml +++ b/docs/reference/docker_compose_run.yaml @@ -65,6 +65,7 @@ options: default_value: "false" description: Run container in background and print container ID deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -73,6 +74,7 @@ options: value_type: string description: Override the entrypoint of the image deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -83,6 +85,7 @@ options: default_value: '[]' description: Set environment variables deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -93,6 +96,7 @@ options: default_value: "true" description: Keep STDIN open even if not attached. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -103,6 +107,7 @@ options: default_value: '[]' description: Add or override a label deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -111,6 +116,7 @@ options: value_type: string description: Assign a name to the container deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -122,6 +128,7 @@ options: description: | Disable pseudo-noTty allocation. By default docker compose run allocates a TTY deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -131,6 +138,7 @@ options: default_value: "false" description: Don't start linked services. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -141,6 +149,7 @@ options: default_value: '[]' description: Publish a container's port(s) to the host. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -150,6 +159,7 @@ options: default_value: "false" description: Pull without printing progress information. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -159,6 +169,7 @@ options: default_value: "false" description: Automatically remove the container when it exits deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -169,6 +180,7 @@ options: description: | Run command with the service's ports enabled and mapped to the host. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -179,6 +191,7 @@ options: default_value: "true" description: Allocate a pseudo-TTY. deprecated: false + hidden: true experimental: false experimentalcli: false kubernetes: false @@ -189,6 +202,7 @@ options: description: | Use the service's network useAliases in the network(s) the container connects to. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -198,6 +212,7 @@ options: value_type: string description: Run as specified username or uid deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -208,6 +223,7 @@ options: default_value: '[]' description: Bind mount a volume. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -217,6 +233,7 @@ options: value_type: string description: Working directory inside the container deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_stop.yaml b/docs/reference/docker_compose_stop.yaml index 04b316d71..e0c74f598 100644 --- a/docs/reference/docker_compose_stop.yaml +++ b/docs/reference/docker_compose_stop.yaml @@ -12,6 +12,7 @@ options: default_value: "10" description: Specify a shutdown timeout in seconds deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_up.yaml b/docs/reference/docker_compose_up.yaml index 4d95fb191..e76c20e83 100644 --- a/docs/reference/docker_compose_up.yaml +++ b/docs/reference/docker_compose_up.yaml @@ -27,6 +27,7 @@ options: description: | Stops all containers if any container was stopped. Incompatible with -d deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -36,6 +37,7 @@ options: default_value: "false" description: Recreate dependent containers. Incompatible with --no-recreate. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -45,6 +47,7 @@ options: default_value: '[]' description: Attach to service output. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -54,6 +57,7 @@ options: default_value: "false" description: Attach to dependent containers. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -63,6 +67,7 @@ options: default_value: "false" description: Build images before starting containers. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -73,6 +78,7 @@ options: default_value: "false" description: 'Detached mode: Run containers in the background' deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -82,6 +88,7 @@ options: description: | Return the exit code of the selected service container. Implies --abort-on-container-exit deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -92,6 +99,7 @@ options: description: | Recreate containers even if their configuration and image haven't changed. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -101,6 +109,7 @@ options: default_value: "false" description: Don't build an image, even if it's missing. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -110,6 +119,7 @@ options: default_value: "false" description: Produce monochrome output. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -119,6 +129,7 @@ options: default_value: "false" description: Don't start linked services. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -128,6 +139,7 @@ options: default_value: "false" description: Don't print prefix in logs. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -138,6 +150,7 @@ options: description: | If containers already exist, don't recreate them. Incompatible with --force-recreate. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -147,6 +160,7 @@ options: default_value: "false" description: Don't start the services after creating them. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -156,6 +170,7 @@ options: default_value: "false" description: Pull without printing progress information. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -165,6 +180,7 @@ options: default_value: "false" description: Remove containers for services not defined in the Compose file. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -176,6 +192,7 @@ options: description: | Recreate anonymous volumes instead of retrieving data from the previous containers. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -186,6 +203,7 @@ options: description: | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -197,6 +215,7 @@ options: description: | Use this timeout in seconds for container shutdown when attached or when containers are already running. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -206,6 +225,7 @@ options: default_value: "false" description: Wait for services to be running|healthy. Implies detached mode. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_version.yaml b/docs/reference/docker_compose_version.yaml index cdc2dd5d7..cc7c5ca34 100644 --- a/docs/reference/docker_compose_version.yaml +++ b/docs/reference/docker_compose_version.yaml @@ -10,6 +10,7 @@ options: value_type: string description: 'Format the output. Values: [pretty | json]. (Default: pretty)' deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false @@ -19,6 +20,7 @@ options: default_value: "false" description: Shows only Compose's version number. deprecated: false + hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/yaml/main/generate.go b/docs/yaml/main/generate.go index 5e7cea943..72f500e78 100644 --- a/docs/yaml/main/generate.go +++ b/docs/yaml/main/generate.go @@ -77,6 +77,6 @@ func main() { fmt.Printf("Project root: %s\n", opts.source) fmt.Printf("Generating yaml files into %s\n", opts.target) if err := generateCliYaml(opts); err != nil { - _, _ = fmt.Fprintf(os.Stderr, "Failed to generate yaml files: %s\n", err.Error()) + _, _ = fmt.Fprintf(os.Stderr, "Failed to generate documentation: %s\n", err.Error()) } } diff --git a/go.mod b/go.mod index ff8122650..2b16a8e2b 100644 --- a/go.mod +++ b/go.mod @@ -12,7 +12,7 @@ require ( github.com/distribution/distribution/v3 v3.0.0-20210316161203-a01c71e2477e github.com/docker/buildx v0.7.1 github.com/docker/cli v20.10.12+incompatible - github.com/docker/cli-docs-tool v0.2.1 + github.com/docker/cli-docs-tool v0.4.0 github.com/docker/docker v20.10.7+incompatible github.com/docker/go-connections v0.4.0 github.com/docker/go-units v0.4.0 diff --git a/go.sum b/go.sum index e3addf95b..0bf7c8297 100644 --- a/go.sum +++ b/go.sum @@ -500,8 +500,9 @@ github.com/docker/buildx v0.7.1 h1:l2DlW8YDbB3pH2bUFY5Q9pPQdhd42wqlnO5hoyWrjYM= github.com/docker/buildx v0.7.1/go.mod h1:PzxALHhYWPNhw/8JajPOJBkvx1w2tgOnppL4ESg0wOY= github.com/docker/cli v20.10.3-0.20210702143511-f782d1355eff+incompatible h1:CaaxCD/l9Dxogu6lxf7AQautlv3sHULrasPadayp0fM= github.com/docker/cli v20.10.3-0.20210702143511-f782d1355eff+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8= -github.com/docker/cli-docs-tool v0.2.1 h1:ffZhhdws6kE+dCKHLMlYROZz8z01RtWbz+g4xz0eBIU= github.com/docker/cli-docs-tool v0.2.1/go.mod h1:rgW5KKdNpLMBIuH4WQ/1RNh38nH+/Ay5jgL4P0ZMPpY= +github.com/docker/cli-docs-tool v0.4.0 h1:MdfKoErGEbFqIxQ8an9BsZ+YzKUGd58RBVkV+Q82GPo= +github.com/docker/cli-docs-tool v0.4.0/go.mod h1:rgW5KKdNpLMBIuH4WQ/1RNh38nH+/Ay5jgL4P0ZMPpY= github.com/docker/compose-on-kubernetes v0.4.19-0.20190128150448-356b2919c496/go.mod h1:iT2pYfi580XlpaV4KmK0T6+4/9+XoKmk/fhoDod1emE= github.com/docker/distribution v0.0.0-20190905152932-14b96e55d84c/go.mod h1:0+TTO4EOBfRPhZXAeF1Vu+W3hHZ8eLp8PgKVZlcvtFY= github.com/docker/distribution v2.6.0-rc.1.0.20180327202408-83389a148052+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w=