817897f891
These were deprecated in 6c400a9c2009bba9376ad61ab59c04c1ad675871 (docker 19.03), but the "Deprecated:" comments were missing a newline before them. While most IDEs will detect such comments as "deprecated", pkg.go.dev and linters will ignore them, which may result in users not being aware of them being deprecated. This patch; - Fixes the "Deprecated:" comments. - Changes the var aliases to functions, which is slightly more boilerplating, but makes sure the functions are documented as "function", instead of shown in the "variables" section on pkg.go.dev. - Adds some punctuation and adds "doc links", which allows readers to navigate to related content on pkg.go.dev. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> |
||
|---|---|---|
| .circleci | ||
| .github | ||
| cli | ||
| cli-plugins | ||
| cmd/docker | ||
| contrib/completion | ||
| dockerfiles | ||
| docs | ||
| e2e | ||
| experimental | ||
| internal/test | ||
| man | ||
| opts | ||
| scripts | ||
| service/logs | ||
| templates | ||
| vendor | ||
| .dockerignore | ||
| .gitattributes | ||
| .gitignore | ||
| .golangci.yml | ||
| .mailmap | ||
| AUTHORS | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| LICENSE | ||
| MAINTAINERS | ||
| Makefile | ||
| NOTICE | ||
| README.md | ||
| TESTING.md | ||
| VERSION | ||
| codecov.yml | ||
| docker-bake.hcl | ||
| docker.Makefile | ||
| vendor.mod | ||
| vendor.sum | ||
README.md
Docker CLI
About
This repository is the home of the cli used in the Docker CE and Docker EE products.
Development
docker/cli is developed using Docker.
Build CLI from source:
docker buildx bake
Build binaries for all supported platforms:
docker buildx bake cross
Build for a specific platform:
docker buildx bake --set binary.platform=linux/arm64
Build dynamic binary for glibc or musl:
USE_GLIBC=1 docker buildx bake dynbinary
Run all linting:
docker buildx bake lint shellcheck
Run test:
docker buildx bake test
List all the available targets:
make help
In-container development environment
Start an interactive development environment:
make -f docker.Makefile shell
Legal
Brought to you courtesy of our legal counsel. For more context, please see the NOTICE document in this repo.
Use and transfer of Docker may be subject to certain restrictions by the United States and other governments.
It is your responsibility to ensure that your use and/or transfer does not violate applicable laws.
For more information, please see https://www.bis.doc.gov
Licensing
docker/cli is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.