DockerCLI/man
Sebastiaan van Stijn 8ee771114c
docker info: include Client Version and "platform name"
This patch adds additional information to the Client section of the output.
We were already outputting versions of CLI Plugins, and the Server, but not
for the Client.

Adding this information can help with bug-reports where the reporter only
provided the `docker info` output, or (e.g.) only `docker --version`. The
platform name helps identify what kind of builds the user has installed
(e.g. docker's docker-ce packages have "Docker Engine - Community" set
for this), although we should consider including "packager" information
as a more formalized field for this information.

Before this patch:

    $ docker info
    Client:
     Context:    default
     Debug Mode: false
     Plugins:
      buildx: Docker Buildx (Docker Inc.)
        Version:  v0.10.4
        Path:     /usr/libexec/docker/cli-plugins/docker-buildx
    ...

With this patch applied:

    $ docker info
    Client: Docker Engine - Community
     Version:    24.0.0-dev
     Context:    default
     Debug Mode: false
     Plugins:
      buildx: Docker Buildx (Docker Inc.)
        Version:  v0.10.4
        Path:     /usr/libexec/docker/cli-plugins/docker-buildx
    ...

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-04-11 18:58:41 +02:00
..
src docker info: include Client Version and "platform name" 2023-04-11 18:58:41 +02:00
.gitignore validate manpages target 2022-02-25 17:11:17 +01:00
Dockerfile.5.md docs: rewrite reference docs for --stop-signal and --stop-timeout 2021-08-21 18:29:07 +02:00
README.md validate manpages target 2022-02-25 17:11:17 +01:00
docker-build.1.md Update man-page source MarkDown to work with go-md2man v2 2020-10-20 12:21:15 +02:00
docker-config-json.5.md Update man-page source MarkDown to work with go-md2man v2 2020-10-20 12:21:15 +02:00
docker-run.1.md tweak description of "docker run" command 2022-04-01 12:28:37 +02:00
docker.1.md docs: man page: typo fix in docker_1 2021-10-01 06:46:38 +03:00
dockerd.8.md Fix the max-concurrent-downloads and max-concurrent-uploads configs documentation 2022-10-28 16:31:27 +01:00
generate.go gofmt with go1.17 2022-03-26 20:21:00 +01:00
go.mod validate manpages target 2022-02-25 17:11:17 +01:00
tools.go gofmt with go1.17 2022-03-26 20:21:00 +01:00

README.md

Docker Documentation

This directory contains scripts for generating the man pages. Many of the man pages are generated directly from the spf13/cobra Command definition. Some legacy pages are still generated from the markdown files in this directory. Do not edit the man pages in the man1 directory. Instead, update the Cobra command or amend the Markdown files for legacy pages.

Generate the man pages

From within the project root directory run:

$ make -f docker.Makefile manpages