Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
DockerCLI/man
History
Sebastiaan van Stijn 0573ec2b01 format (GoDoc) comments with Go 1.19 to prepare for go updates 
Older versions of Go do not format these comments, so we can already
reformat them ahead of time to prevent gofmt linting failing once
we update to Go 1.19 or up.

Result of:

    gofmt -s -w $(find . -type f -name '*.go' | grep -v "/vendor/")

With some manual adjusting.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 82427d1a07)
Signed-off-by: Cory Snider <csnider@mirantis.com>
 		2023-02-27 17:00:55 -05:00
..
src docs/reference: info: update example output 2023-01-07 12:51:23 +01:00
Dockerfile.5.md docs: rewrite reference docs for --stop-signal and --stop-timeout 2021-10-06 16:48:50 +02:00
README.md Make README less scabious 2017-06-02 00:10:02 +00: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 docs: rewrite reference docs for --stop-signal and --stop-timeout 2021-10-06 16:48:50 +02:00
docker.1.md Update man-page source MarkDown to work with go-md2man v2 2020-10-20 12:21:15 +02:00
dockerd.8.md Fix the max-concurrent-downloads and max-concurrent-uploads configs documentation 2022-12-20 15:02:47 -03:00
generate.go man: remove deprecated io/ioutil and use t.TempDir() 2023-02-27 16:28:59 -05:00
import.go format (GoDoc) comments with Go 1.19 to prepare for go updates 2023-02-27 17:00:55 -05:00
md2man-all.sh Rename bin/md2man to bin/go-md2man 2021-02-04 14:50:45 +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 manpages