diff options
| author | Cory Snider <csnider@mirantis.com> | 2023-03-31 16:15:01 -0400 |
|---|---|---|
| committer | Sebastiaan van Stijn <github@gone.nl> | 2023-04-21 12:05:15 +0200 |
| commit | 61d084593c815bb2c40dedc3026901023f46b9f9 (patch) | |
| tree | fc78b44f25d6fe3a7bb2980d058d8594685bce6b | |
| parent | 8fdca288c5c9d84dc27ed65b4e67c885452e27e9 (diff) | |
| download | docker-61d084593c815bb2c40dedc3026901023f46b9f9.tar.gz | |
client: deprecate NewClient properly
The 'Deprecated:' line in NewClient's doc comment was not in a new
paragraph, so GoDoc, linters, and IDEs were unaware that it was
deprecated. The package documentation also continued to reference
NewClient. Update the doc comments to finish documenting that NewClient
is deprecated.
Signed-off-by: Cory Snider <csnider@mirantis.com>
(cherry picked from commit 6b9968e8b10268d76725ce187c9ad800c75cd8b8)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
| -rw-r--r-- | client/client.go | 7 | ||||
| -rw-r--r-- | client/client_deprecated.go | 8 |
2 files changed, 10 insertions, 5 deletions
diff --git a/client/client.go b/client/client.go index 26a0fa2756..09ea4851ff 100644 --- a/client/client.go +++ b/client/client.go @@ -6,9 +6,10 @@ https://docs.docker.com/engine/api/ # Usage -You use the library by creating a client object and calling methods on it. The -client can be created either from environment variables with NewClientWithOpts(client.FromEnv), -or configured manually with NewClient(). +You use the library by constructing a client object using [NewClientWithOpts] +and calling methods on it. The client can be configured from environment +variables by passing the [FromEnv] option, or configured manually by passing any +of the other available [Opts]. For example, to list running containers (the equivalent of "docker ps"): diff --git a/client/client_deprecated.go b/client/client_deprecated.go index 54cdfc29a8..9e366ce20d 100644 --- a/client/client_deprecated.go +++ b/client/client_deprecated.go @@ -9,7 +9,11 @@ import "net/http" // It won't send any version information if the version number is empty. It is // highly recommended that you set a version or your client may break if the // server is upgraded. -// Deprecated: use NewClientWithOpts +// +// Deprecated: use [NewClientWithOpts] passing the [WithHost], [WithVersion], +// [WithHTTPClient] and [WithHTTPHeaders] options. We recommend enabling API +// version negotiation by passing the [WithAPIVersionNegotiation] option instead +// of WithVersion. func NewClient(host string, version string, client *http.Client, httpHeaders map[string]string) (*Client, error) { return NewClientWithOpts(WithHost(host), WithVersion(version), WithHTTPClient(client), WithHTTPHeaders(httpHeaders)) } @@ -17,7 +21,7 @@ func NewClient(host string, version string, client *http.Client, httpHeaders map // NewEnvClient initializes a new API client based on environment variables. // See FromEnv for a list of support environment variables. // -// Deprecated: use NewClientWithOpts(FromEnv) +// Deprecated: use [NewClientWithOpts] passing the [FromEnv] option. func NewEnvClient() (*Client, error) { return NewClientWithOpts(FromEnv) } |