mirror of https://github.com/docker/cli.git
4db608f186
Issue #30082 demonstrated that their is possible confusion with the "/." where the tailing "." can appear to be merely punctuation within the document rather than a highly pertinent part of `SRC_PATH`. Signed-off-by: Ian Campbell <ian.campbell@docker.com> |
||
---|---|---|
.. | ||
src | ||
Dockerfile | ||
Dockerfile.5.md | ||
Dockerfile.aarch64 | ||
Dockerfile.armhf | ||
Dockerfile.ppc64le | ||
Dockerfile.s390x | ||
README.md | ||
docker-build.1.md | ||
docker-config-json.5.md | ||
docker-run.1.md | ||
docker.1.md | ||
dockerd.8.md | ||
generate.go | ||
generate.sh | ||
glide.lock | ||
glide.yaml | ||
md2man-all.sh |
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