Merge pull request #4524 from thaJeztah/docs_update_golang_links

docs, man, contribute: update links to go documentation, and use https where available
This commit is contained in:
Sebastiaan van Stijn 2023-08-25 17:22:47 +02:00 committed by GitHub
commit 39296a9b19
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
20 changed files with 24 additions and 25 deletions

View File

@ -192,7 +192,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
@ -336,9 +336,8 @@ The rules:
1. All code should be formatted with `gofumpt` (preferred) or `gofmt -s`. 1. All code should be formatted with `gofumpt` (preferred) or `gofmt -s`.
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](https://go.dev/doc/effective_go)
Go](http://golang.org/doc/effective_go.html) and [Go Code Review and [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments).
Comments](https://github.com/golang/go/wiki/CodeReviewComments).
4. Comment the code. Tell us the why, the history and the context. 4. Comment the code. 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
@ -360,6 +359,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.

View File

@ -16,7 +16,7 @@ type osArch struct {
// Remove any unsupported os/arch combo // Remove any unsupported os/arch combo
// list of valid os/arch values (see "Optional Environment Variables" section // list of valid os/arch values (see "Optional Environment Variables" section
// of https://golang.org/doc/install/source // of https://go.dev/doc/install/source
// Added linux/s390x as we know System z support already exists // Added linux/s390x as we know System z support already exists
// Keep in sync with _docker_manifest_annotate in contrib/completion/bash/docker // Keep in sync with _docker_manifest_annotate in contrib/completion/bash/docker
var validOSArches = map[osArch]bool{ var validOSArches = map[osArch]bool{

View File

@ -20,7 +20,7 @@ Inspects the specified config.
By default, this renders all results in a JSON array. If a format is specified, By default, this renders all results in a JSON array. If a format is specified,
the given template will be executed for each result. the given template will be executed for each result.
Go's [text/template](https://golang.org/pkg/text/template/) package Go's [text/template](https://pkg.go.dev/text/template) package
describes all the details of the format. describes all the details of the format.
For detailed information about using configs, refer to [store configuration data using Docker Configs](https://docs.docker.com/engine/swarm/configs/). For detailed information about using configs, refer to [store configuration data using Docker Configs](https://docs.docker.com/engine/swarm/configs/).

View File

@ -194,7 +194,7 @@ The currently supported filters are:
If a format (`--format`) is specified, the given template will be executed If a format (`--format`) is specified, the given template will be executed
instead of the default instead of the default
format. Go's [text/template](https://golang.org/pkg/text/template/) package format. Go's [text/template](https://pkg.go.dev/text/template) package
describes all the details of the format. describes all the details of the format.
If a format is set to `{{json .}}`, the events are streamed as valid JSON If a format is set to `{{json .}}`, the events are streamed as valid JSON

View File

@ -24,7 +24,7 @@ The number of images shown is the number of unique images. The same image tagged
under different names is counted only once. under different names is counted only once.
If a format is specified, the given template will be executed instead of the If a format is specified, the given template will be executed instead of the
default format. Go's [text/template](https://golang.org/pkg/text/template/) package default format. Go's [text/template](https://pkg.go.dev/text/template) package
describes all the details of the format. describes all the details of the format.
Depending on the storage driver in use, additional information can be shown, such Depending on the storage driver in use, additional information can be shown, such

View File

@ -24,7 +24,7 @@ By default, `docker inspect` will render results in a JSON array.
If a format is specified, the given template will be executed for each result. If a format is specified, the given template will be executed for each result.
Go's [text/template](https://golang.org/pkg/text/template/) package describes Go's [text/template](https://pkg.go.dev/text/template) package describes
all the details of the format. all the details of the format.
### <a name="type"></a> Specify target type (--type) ### <a name="type"></a> Specify target type (--type)

View File

@ -34,7 +34,7 @@ the container's `STDOUT` and `STDERR`.
Passing a negative number or a non-integer to `--tail` is invalid and the Passing a negative number or a non-integer to `--tail` is invalid and the
value is set to `all` in that case. value is set to `all` in that case.
The `docker logs --timestamps` command will add an [RFC3339Nano timestamp](https://golang.org/pkg/time/#pkg-constants) The `docker logs --timestamps` command will add an [RFC3339Nano timestamp](https://pkg.go.dev/time#RFC3339Nano)
, for example `2014-09-16T06:17:46.000000000Z`, to each , for example `2014-09-16T06:17:46.000000000Z`, to each
log entry. To ensure that the timestamps are aligned the log entry. To ensure that the timestamps are aligned the
nano-second part of the timestamp will be padded with zero when necessary. nano-second part of the timestamp will be padded with zero when necessary.

View File

@ -41,7 +41,7 @@ node are shown.
You can specify an alternate format to execute a given You can specify an alternate format to execute a given
template for each result. Go's template for each result. Go's
[text/template](https://golang.org/pkg/text/template/) package describes all the [text/template](https://pkg.go.dev/text/template) package describes all the
details of the format. details of the format.
```console ```console

View File

@ -18,7 +18,7 @@ Display detailed information on one or more nodes
Returns information about a node. By default, this command renders all results Returns information about a node. By default, this command renders all results
in a JSON array. You can specify an alternate format to execute a in a JSON array. You can specify an alternate format to execute a
given template for each result. Go's given template for each result. Go's
[text/template](https://golang.org/pkg/text/template/) package describes all the [text/template](https://pkg.go.dev/text/template) package describes all the
details of the format. details of the format.
> **Note** > **Note**

View File

@ -20,7 +20,7 @@ Inspects the specified secret.
By default, this renders all results in a JSON array. If a format is specified, By default, this renders all results in a JSON array. If a format is specified,
the given template will be executed for each result. the given template will be executed for each result.
Go's [text/template](https://golang.org/pkg/text/template/) package Go's [text/template](https://pkg.go.dev/text/template) package
describes all the details of the format. describes all the details of the format.
For detailed information about using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/). For detailed information about using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/).

View File

@ -1014,7 +1014,7 @@ registry value must be located in:
### Create services using templates ### Create services using templates
You can use templates for some flags of `service create`, using the syntax You can use templates for some flags of `service create`, using the syntax
provided by the Go's [text/template](https://golang.org/pkg/text/template/) package. provided by the Go's [text/template](https://pkg.go.dev/text/template) package.
The supported flags are the following : The supported flags are the following :

View File

@ -20,7 +20,7 @@ Inspects the specified service.
By default, this renders all results in a JSON array. If a format is specified, By default, this renders all results in a JSON array. If a format is specified,
the given template will be executed for each result. the given template will be executed for each result.
Go's [text/template](https://golang.org/pkg/text/template/) package Go's [text/template](https://pkg.go.dev/text/template) package
describes all the details of the format. describes all the details of the format.
> **Note** > **Note**

View File

@ -50,7 +50,7 @@ the service's `STDOUT` and `STDERR`.
Passing a negative number or a non-integer to `--tail` is invalid and the Passing a negative number or a non-integer to `--tail` is invalid and the
value is set to `all` in that case. value is set to `all` in that case.
The `docker service logs --timestamps` command will add an [RFC3339Nano timestamp](https://golang.org/pkg/time/#pkg-constants) The `docker service logs --timestamps` command will add an [RFC3339Nano timestamp](https://pkg.go.dev/time#RFC3339Nano)
, for example `2014-09-16T06:17:46.000000000Z`, to each , for example `2014-09-16T06:17:46.000000000Z`, to each
log entry. To ensure that the timestamps are aligned the log entry. To ensure that the timestamps are aligned the
nano-second part of the timestamp will be padded with zero when necessary. nano-second part of the timestamp will be padded with zero when necessary.

View File

@ -308,7 +308,7 @@ $ docker system events --filter 'type=plugin'
### <a name="format"></a> Format the output (--format) ### <a name="format"></a> Format the output (--format)
If a format (`--format`) is specified, the given template will be executed If a format (`--format`) is specified, the given template will be executed
instead of the default format. Go's [text/template](https://golang.org/pkg/text/template/) instead of the default format. Go's [text/template](https://pkg.go.dev/text/template)
package describes all the details of the format. package describes all the details of the format.
```console ```console

View File

@ -17,7 +17,7 @@ Display detailed information on one or more volumes
Returns information about a volume. By default, this command renders all results Returns information about a volume. By default, this command renders all results
in a JSON array. You can specify an alternate format to execute a in a JSON array. You can specify an alternate format to execute a
given template for each result. Go's given template for each result. Go's
[text/template](https://golang.org/pkg/text/template/) package describes all the [text/template](https://pkg.go.dev/text/template) package describes all the
details of the format. details of the format.
## Examples ## Examples

View File

@ -9,7 +9,7 @@ container is unpaused, and then run
# CAPABILITIES # CAPABILITIES
`privileged` gives the process extended `privileged` gives the process extended
[Linux capabilities](http://man7.org/linux/man-pages/man7/capabilities.7.html) [Linux capabilities](https://man7.org/linux/man-pages/man7/capabilities.7.html)
when running in a container. when running in a container.
Without this flag, the process run by `docker exec` in a running container has Without this flag, the process run by `docker exec` in a running container has

View File

@ -193,7 +193,7 @@ output:
80/tcp -> 80 80/tcp -> 80
You can get more information about how to write a Go template from: You can get more information about how to write a Go template from:
https://golang.org/pkg/text/template/. https://pkg.go.dev/text/template.
## Getting size information on a container ## Getting size information on a container

View File

@ -11,7 +11,7 @@ bda12f8922785d1f160be70736f26c1e331ab8aaf8ed8d56728508f2e2fd4727
The `network inspect` command shows the containers, by id, in its The `network inspect` command shows the containers, by id, in its
results. You can specify an alternate format to execute a given results. You can specify an alternate format to execute a given
template for each result. Go's template for each result. Go's
[text/template](http://golang.org/pkg/text/template/) package [text/template](https://pkg.go.dev/text/template) package
describes all the details of the format. describes all the details of the format.
```console ```console

View File

@ -85,7 +85,7 @@ details of the format.
Type=container Status=destroy ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 Type=container Status=destroy ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26
If a format is set to `{{json .}}`, the events are streamed as valid JSON If a format is set to `{{json .}}`, the events are streamed as valid JSON
Lines. For information about JSON Lines, please refer to http://jsonlines.org/ . Lines. For information about JSON Lines, please refer to https://jsonlines.org .
# docker events --format '{{json .}}' # docker events --format '{{json .}}'
{"status":"create","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4.. {"status":"create","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4..

View File

@ -1,4 +1,4 @@
Returns information about one or more volumes. By default, this command renders Returns information about one or more volumes. By default, this command renders
all results in a JSON array. You can specify an alternate format to execute a all results in a JSON array. You can specify an alternate format to execute a
given template is executed for each result. Go's https://golang.org/pkg/text/template/ given template is executed for each result. Go's https://pkg.go.dev/text/template
package describes all the details of the format. package describes all the details of the format.