style: apply global formatting fixes (struct, spacing, zhlint)

This commit is contained in:
Baohua Yang
2026-02-21 11:08:52 -08:00
parent ad68b2d973
commit 79ac9c639a
159 changed files with 1708 additions and 882 deletions

View File

@@ -16,7 +16,7 @@ docker compose [-f=<arg>...] [options] [COMMAND] [ARGS...]
### 命令选项
* `-f, --file FILE` 指定使用的 Compose 模板文件默认会自动识别 `compose.yaml`也兼容 `docker-compose.yml` 并且可以多次指定
* `-f, --file FILE` 指定使用的 Compose 模板文件默认会自动识别 `compose.yaml` (也兼容 `docker-compose.yml` )并且可以多次指定
* `-p, --project-name NAME` 指定项目名称默认将使用所在目录名称作为项目名
@@ -26,11 +26,13 @@ docker compose [-f=<arg>...] [options] [COMMAND] [ARGS...]
### 命令使用说明
本节涵盖了相关内容与详细描述主要探讨以下几个方面
#### `build`
格式为 `docker compose build [options] [SERVICE...]`
构建重新构建项目中的服务容器
构建 (重新构建) 项目中的服务容器
服务容器一旦构建后将会带上一个标记名例如对于 web 项目中的一个 db 容器可能是 web_db
@@ -40,7 +42,7 @@ docker compose [-f=<arg>...] [options] [COMMAND] [ARGS...]
* `--force-rm` 删除构建过程中的临时容器
* `--no-cache` 构建镜像过程中不使用 cache这将加长构建过程
* `--no-cache` 构建镜像过程中不使用 cache (这将加长构建过程)
* `--pull` 始终尝试通过 pull 来获取更新版本的镜像
@@ -98,9 +100,9 @@ $ docker compose kill -s SIGINT
选项
* `--protocol=proto` 指定端口协议tcp默认值或者 udp
* `--protocol=proto` 指定端口协议tcp (默认值) 或者 udp
* `--index=index` 如果同一服务存在多个容器指定命令对象容器的序号默认为 1
* `--index=index` 如果同一服务存在多个容器指定命令对象容器的序号 (默认为 1)
#### `ps`
@@ -134,13 +136,13 @@ $ docker compose kill -s SIGINT
选项
* `-t, --timeout TIMEOUT` 指定重启前停止容器的超时默认为 10
* `-t, --timeout TIMEOUT` 指定重启前停止容器的超时 (默认为 10 )
#### `rm`
格式为 `docker compose rm [options] [SERVICE...]`
删除所有停止状态的服务容器推荐先执行 `docker compose stop` 命令来停止容器
删除所有 (停止状态的) 服务容器推荐先执行 `docker compose stop` 命令来停止容器
选项
@@ -216,7 +218,7 @@ $ docker compose scale web=3 db=2
将启动 3 个容器运行 web 服务2 个容器运行 db 服务
> **提示**部分版本的 Compose 可能不再提供独立的 `scale` 子命令或不推荐使用此时可使用 `docker compose up` `--scale` 选项达到同样效果
> **提示**部分版本的 Compose 可能不再提供独立的 `scale` 子命令 (或不推荐使用)此时可使用 `docker compose up` `--scale` 选项达到同样效果
>
> ```bash
> $ docker compose up -d --scale web=3 --scale db=2
@@ -226,7 +228,7 @@ $ docker compose scale web=3 db=2
选项
* `-t, --timeout TIMEOUT` 停止容器时候的超时默认为 10
* `-t, --timeout TIMEOUT` 停止容器时候的超时 (默认为 10 )
#### `start`
@@ -242,7 +244,7 @@ $ docker compose scale web=3 db=2
选项
* `-t, --timeout TIMEOUT` 停止容器时候的超时默认为 10
* `-t, --timeout TIMEOUT` 停止容器时候的超时 (默认为 10 )
#### `top`
@@ -258,7 +260,7 @@ $ docker compose scale web=3 db=2
格式为 `docker compose up [options] [SERVICE...]`
该命令十分强大它将尝试自动完成包括构建镜像重新创建服务启动服务并关联服务相关容器的一系列操作
该命令十分强大它将尝试自动完成包括构建镜像(重新) 创建服务启动服务并关联服务相关容器的一系列操作
链接的服务都将会被自动启动除非已经处于运行状态
@@ -270,7 +272,7 @@ $ docker compose scale web=3 db=2
如果使用 `docker compose up -d`将会在后台启动并运行所有的容器一般推荐生产环境下使用该选项
默认情况如果服务容器已经存在`docker compose up` 将会尝试停止容器然后重新创建保持使用 `volumes-from` 挂载的卷以保证新启动的服务匹配 Compose 文件的最新内容如果用户不希望容器被停止并重新创建可以使用 `docker compose up --no-recreate`这样将只会启动处于停止状态的容器而忽略已经运行的服务如果用户只想重新部署某个服务可以使用 `docker compose up --no-deps -d <SERVICE_NAME>` 来重新创建服务并后台停止旧服务启动新服务并不会影响到其所依赖的服务
默认情况如果服务容器已经存在`docker compose up` 将会尝试停止容器然后重新创建 (保持使用 `volumes-from` 挂载的卷)以保证新启动的服务匹配 Compose 文件的最新内容如果用户不希望容器被停止并重新创建可以使用 `docker compose up --no-recreate`这样将只会启动处于停止状态的容器而忽略已经运行的服务如果用户只想重新部署某个服务可以使用 `docker compose up --no-deps -d <SERVICE_NAME>` 来重新创建服务并后台停止旧服务启动新服务并不会影响到其所依赖的服务
选项
@@ -286,7 +288,7 @@ $ docker compose scale web=3 db=2
* `--no-build` 不自动构建缺失的服务镜像
* `-t, --timeout TIMEOUT` 停止容器时候的超时默认为 10
* `-t, --timeout TIMEOUT` 停止容器时候的超时 (默认为 10 )
#### `version`