1berry/docker-compose
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update link in stats --help output

Browse Source 
Signed-off-by: Max Proske <max@mproske.com>
This commit is contained in:
Max Proske 2025-02-03 22:21:50 -08:00 committed by Nicolas De loof
parent 5e2abb6c26
commit 40cd08f318
10 changed files with 34 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
BUILDING.md
View File

@ -2,10 +2,10 @@
### Prerequisites ### Prerequisites
* Windows: * Windows:
* [Docker Desktop](https://hub.docker.com/editions/community/docker-ce-desktop-windows) * [Docker Desktop](https://docs.docker.com/desktop/setup/install/windows-install/)
* make * make
* macOS: * macOS:
* [Docker Desktop](https://hub.docker.com/editions/community/docker-ce-desktop-mac) * [Docker Desktop](https://docs.docker.com/desktop/setup/install/mac-install/)
* make * make
* Linux: * Linux:
* [Docker 20.10 or later](https://docs.docker.com/engine/install/) * [Docker 20.10 or later](https://docs.docker.com/engine/install/)

18
CONTRIBUTING.md
View File

@ -2,7 +2,7 @@
Want to hack on Docker? Awesome! We have a contributor's guide that explains Want to hack on Docker? Awesome! We have a contributor's guide that explains
[setting up a Docker development environment and the contribution [setting up a Docker development environment and the contribution
process](https://docs.docker.com/contribute/overview/). process](https://docs.docker.com/contribute/).
This page contains information about reporting issues as well as some tips and This page contains information about reporting issues as well as some tips and
guidelines useful to experienced open source contributors. Finally, make sure guidelines useful to experienced open source contributors. Finally, make sure
@ -95,7 +95,7 @@ don't get discouraged!
<tr> <tr>
<td>Community Slack</td> <td>Community Slack</td>
<td> <td>
The Docker Community has a dedicated Slack chat to discuss features and issues. You can sign-up <a href="https://www.docker.com/docker-community" target="_blank">with this link</a>. The Docker Community has a dedicated Slack chat to discuss features and issues. You can sign-up <a href="https://www.docker.com/community/" target="_blank">with this link</a>.
</td> </td>
</tr> </tr>
<tr> <tr>
@ -118,7 +118,7 @@ don't get discouraged!
<td>Stack Overflow</td> <td>Stack Overflow</td>
<td> <td>
Stack Overflow has over 17000 Docker questions listed. We regularly Stack Overflow has over 17000 Docker questions listed. We regularly
monitor <a href="https://stackoverflow.com/search?tab=newest&q=docker" target="_blank">Docker questions</a> monitor <a href="https://stackoverflow.com/questions/tagged/docker" target="_blank">Docker questions</a>
and so do many other knowledgeable Docker users. and so do many other knowledgeable Docker users.
</td> </td>
</tr> </tr>
@ -200,7 +200,7 @@ For more details, see the [MAINTAINERS](MAINTAINERS) page.
The sign-off is a simple line at the end of the explanation for the patch. Your The sign-off is a simple line at the end of the explanation for the patch. Your
signature certifies that you wrote the patch or otherwise have the right to pass signature certifies that you wrote the patch or otherwise have the right to pass
it on as an open-source patch. The rules are pretty simple: if you can certify it on as an open-source patch. The rules are pretty simple: if you can certify
the below (from [developercertificate.org](http://developercertificate.org/)): the below (from [developercertificate.org](https://developercertificate.org/)):
``` ```
Developer Certificate of Origin Developer Certificate of Origin
@ -252,7 +252,7 @@ commit automatically with `git commit -s`.
### How can I become a maintainer? ### How can I become a maintainer?
The procedures for adding new maintainers are explained in the global The procedures for adding new maintainers are explained in the global
[MAINTAINERS](https://github.com/docker/opensource/blob/master/MAINTAINERS) [MAINTAINERS](https://github.com/docker/opensource/blob/main/MAINTAINERS)
file in the file in the
[https://github.com/docker/opensource/](https://github.com/docker/opensource/) [https://github.com/docker/opensource/](https://github.com/docker/opensource/)
repository. repository.
@ -311,8 +311,8 @@ The rules:
2. All code should pass the default levels of 2. All code should pass the default levels of
[`golint`](https://github.com/golang/lint). [`golint`](https://github.com/golang/lint).
3. All code should follow the guidelines covered in [Effective 3. All code should follow the guidelines covered in [Effective
Go](http://golang.org/doc/effective_go.html) and [Go Code Review Go](https://go.dev/doc/effective_go) and [Go Code Review
Comments](https://github.com/golang/go/wiki/CodeReviewComments). Comments](https://go.dev/wiki/CodeReviewComments).
4. Include code comments. Tell us the why, the history and the context. 4. Include code comments. Tell us the why, the history and the context.
5. Document _all_ declarations and methods, even private ones. Declare 5. Document _all_ declarations and methods, even private ones. Declare
expectations, caveats and anything else that may be important. If a type expectations, caveats and anything else that may be important. If a type
@ -334,6 +334,6 @@ The rules:
guidelines. Since you've read all the rules, you now know that. guidelines. Since you've read all the rules, you now know that.
If you are having trouble getting into the mood of idiomatic Go, we recommend If you are having trouble getting into the mood of idiomatic Go, we recommend
reading through [Effective Go](https://golang.org/doc/effective_go.html). The reading through [Effective Go](https://go.dev/doc/effective_go). The
[Go Blog](https://blog.golang.org) is also a great resource. Drinking the [Go Blog](https://go.dev/blog/) is also a great resource. Drinking the
kool-aid is a lot easier than going thirsty. kool-aid is a lot easier than going thirsty.

4
README.md
View File

@ -8,7 +8,7 @@
- [Legacy](#legacy) - [Legacy](#legacy)
# Docker Compose v2 # Docker Compose v2
[![GitHub release](https://img.shields.io/github/release/docker/compose.svg?style=flat-square)](https://github.com/docker/compose/releases/latest) [![GitHub release](https://img.shields.io/github/v/release/docker/compose.svg?style=flat-square)](https://github.com/docker/compose/releases/latest)
[![PkgGoDev](https://img.shields.io/badge/go.dev-docs-007d9c?style=flat-square&logo=go&logoColor=white)](https://pkg.go.dev/github.com/docker/compose/v2) [![PkgGoDev](https://img.shields.io/badge/go.dev-docs-007d9c?style=flat-square&logo=go&logoColor=white)](https://pkg.go.dev/github.com/docker/compose/v2)
[![Build Status](https://img.shields.io/github/actions/workflow/status/docker/compose/ci.yml?label=ci&logo=github&style=flat-square)](https://github.com/docker/compose/actions?query=workflow%3Aci) [![Build Status](https://img.shields.io/github/actions/workflow/status/docker/compose/ci.yml?label=ci&logo=github&style=flat-square)](https://github.com/docker/compose/actions?query=workflow%3Aci)
[![Go Report Card](https://goreportcard.com/badge/github.com/docker/compose/v2?style=flat-square)](https://goreportcard.com/report/github.com/docker/compose/v2) [![Go Report Card](https://goreportcard.com/badge/github.com/docker/compose/v2?style=flat-square)](https://goreportcard.com/report/github.com/docker/compose/v2)
@ -28,7 +28,7 @@ single command: `docker compose up`.
### Windows and macOS ### Windows and macOS
Docker Compose is included in Docker Compose is included in
[Docker Desktop](https://www.docker.com/products/docker-desktop) [Docker Desktop](https://www.docker.com/products/docker-desktop/)
for Windows and macOS. for Windows and macOS.
### Linux ### Linux

2
cmd/compose/stats.go
View File

@ -56,7 +56,7 @@ func statsCommand(p *ProjectOptions, dockerCli command.Cli) *cobra.Command {
'table TEMPLATE': Print output in table format using the given Go template 'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format 'json': Print in JSON format
'TEMPLATE': Print output using the given Go template. 'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates`) Refer to https://docs.docker.com/engine/cli/formatting/ for more information about formatting output with templates`)
flags.BoolVar(&opts.noStream, "no-stream", false, "Disable streaming stats and only pull the first result") flags.BoolVar(&opts.noStream, "no-stream", false, "Disable streaming stats and only pull the first result")
flags.BoolVar(&opts.noTrunc, "no-trunc", false, "Do not truncate output") flags.BoolVar(&opts.noTrunc, "no-trunc", false, "Do not truncate output")
return cmd return cmd

8
docs/reference/compose_build.md
View File

@ -4,9 +4,9 @@
Services are built once and then tagged, by default as `project-service`. Services are built once and then tagged, by default as `project-service`.
If the Compose file specifies an If the Compose file specifies an
[image](https://github.com/compose-spec/compose-spec/blob/master/spec.md#image) name, [image](https://github.com/compose-spec/compose-spec/blob/main/spec.md#image) name,
the image is tagged with that name, substituting any variables beforehand. See the image is tagged with that name, substituting any variables beforehand. See
[variable interpolation](https://github.com/compose-spec/compose-spec/blob/master/spec.md#interpolation). [variable interpolation](https://github.com/compose-spec/compose-spec/blob/main/spec.md#interpolation).
If you change a service's `Dockerfile` or the contents of its build directory, If you change a service's `Dockerfile` or the contents of its build directory,
run `docker compose build` to rebuild it. run `docker compose build` to rebuild it.
@ -34,9 +34,9 @@ run `docker compose build` to rebuild it.
Services are built once and then tagged, by default as `project-service`. Services are built once and then tagged, by default as `project-service`.
If the Compose file specifies an If the Compose file specifies an
[image](https://github.com/compose-spec/compose-spec/blob/master/spec.md#image) name, [image](https://github.com/compose-spec/compose-spec/blob/main/spec.md#image) name,
the image is tagged with that name, substituting any variables beforehand. See the image is tagged with that name, substituting any variables beforehand. See
[variable interpolation](https://github.com/compose-spec/compose-spec/blob/master/spec.md#interpolation). [variable interpolation](https://github.com/compose-spec/compose-spec/blob/main/spec.md#interpolation).
If you change a service's `Dockerfile` or the contents of its build directory, If you change a service's `Dockerfile` or the contents of its build directory,
run `docker compose build` to rebuild it. run `docker compose build` to rebuild it.

8
docs/reference/compose_restart.md
View File

@ -9,8 +9,8 @@ after a container is built, but before the container's command is executed) are
after restarting. after restarting.
If you are looking to configure a service's restart policy, refer to If you are looking to configure a service's restart policy, refer to
[restart](https://github.com/compose-spec/compose-spec/blob/master/spec.md#restart) [restart](https://github.com/compose-spec/compose-spec/blob/main/spec.md#restart)
or [restart_policy](https://github.com/compose-spec/compose-spec/blob/master/deploy.md#restart_policy). or [restart_policy](https://github.com/compose-spec/compose-spec/blob/main/deploy.md#restart_policy).
### Options ### Options
@ -33,5 +33,5 @@ after a container is built, but before the container's command is executed) are
after restarting. after restarting.
If you are looking to configure a service's restart policy, refer to If you are looking to configure a service's restart policy, refer to
[restart](https://github.com/compose-spec/compose-spec/blob/master/spec.md#restart) [restart](https://github.com/compose-spec/compose-spec/blob/main/spec.md#restart)
or [restart_policy](https://github.com/compose-spec/compose-spec/blob/master/deploy.md#restart_policy). or [restart_policy](https://github.com/compose-spec/compose-spec/blob/main/deploy.md#restart_policy).

14
docs/reference/compose_stats.md
View File

@ -5,13 +5,13 @@ Display a live stream of container(s) resource usage statistics
### Options ### Options
| Name | Type | Default | Description | | Name | Type | Default | Description |
|:--------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:--------------|:---------|:--------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `-a`, `--all` | `bool` | | Show all containers (default shows just running) | | `-a`, `--all` | `bool` | | Show all containers (default shows just running) |
| `--dry-run` | `bool` | | Execute command in dry run mode | | `--dry-run` | `bool` | | Execute command in dry run mode |
| `--format` | `string` | | Format output using a custom template:<br>'table': Print output in table format with column headers (default)<br>'table TEMPLATE': Print output in table format using the given Go template<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | | `--format` | `string` | | Format output using a custom template:<br>'table': Print output in table format with column headers (default)<br>'table TEMPLATE': Print output in table format using the given Go template<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/engine/cli/formatting/ for more information about formatting output with templates |
| `--no-stream` | `bool` | | Disable streaming stats and only pull the first result | | `--no-stream` | `bool` | | Disable streaming stats and only pull the first result |
| `--no-trunc` | `bool` | | Do not truncate output | | `--no-trunc` | `bool` | | Do not truncate output |
<!---MARKER_GEN_END--> <!---MARKER_GEN_END-->

4
docs/reference/docker_compose_build.yaml
View File

@ -4,9 +4,9 @@ long: |-
Services are built once and then tagged, by default as `project-service`. Services are built once and then tagged, by default as `project-service`.
If the Compose file specifies an If the Compose file specifies an
[image](https://github.com/compose-spec/compose-spec/blob/master/spec.md#image) name, [image](https://github.com/compose-spec/compose-spec/blob/main/spec.md#image) name,
the image is tagged with that name, substituting any variables beforehand. See the image is tagged with that name, substituting any variables beforehand. See
[variable interpolation](https://github.com/compose-spec/compose-spec/blob/master/spec.md#interpolation). [variable interpolation](https://github.com/compose-spec/compose-spec/blob/main/spec.md#interpolation).
If you change a service's `Dockerfile` or the contents of its build directory, If you change a service's `Dockerfile` or the contents of its build directory,
run `docker compose build` to rebuild it. run `docker compose build` to rebuild it.

4
docs/reference/docker_compose_restart.yaml
View File

@ -9,8 +9,8 @@ long: |-
after restarting. after restarting.
If you are looking to configure a service's restart policy, refer to If you are looking to configure a service's restart policy, refer to
[restart](https://github.com/compose-spec/compose-spec/blob/master/spec.md#restart) [restart](https://github.com/compose-spec/compose-spec/blob/main/spec.md#restart)
or [restart_policy](https://github.com/compose-spec/compose-spec/blob/master/deploy.md#restart_policy). or [restart_policy](https://github.com/compose-spec/compose-spec/blob/main/deploy.md#restart_policy).
usage: docker compose restart [OPTIONS] [SERVICE...] usage: docker compose restart [OPTIONS] [SERVICE...]
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml

2
docs/reference/docker_compose_stats.yaml
View File

@ -24,7 +24,7 @@ options:
'table TEMPLATE': Print output in table format using the given Go template 'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format 'json': Print in JSON format
'TEMPLATE': Print output using the given Go template. 'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates Refer to https://docs.docker.com/engine/cli/formatting/ for more information about formatting output with templates
deprecated: false deprecated: false
hidden: false hidden: false
experimental: false experimental: false