mirror of https://github.com/docker/cli.git
6e2607c6a6
In the recent PR !2877, some code was added to check if md2man is already installed in the build environment. This is to cater to the needs of Linux distributions. However it turns out that Linux distributions install md2man as bin/go-md2man instead of bin/md2man, hence the PR !2877 doesn't help much. This commit fixes it by settling on using the binary name go-md2man. For reference, here the file list of the package go-md2man in several distributions: - Debian: <https://packages.debian.org/sid/amd64/go-md2man/filelist> - Ubuntu: <https://packages.ubuntu.com/hirsute/amd64/go-md2man/filelist> - Fedora: <https://fedora.pkgs.org/31/fedora-x86_64/golang-github-cpuguy83-md2man-2.0.0-0.4.20190624gitf79a8a8.fc31.x86_64.rpm.html> - ArchLinux: <https://www.archlinux.org/packages/community/x86_64/go-md2man/> Signed-off-by: Arnaud Rebillout <elboulangero@gmail.com> |
||
|---|---|---|
| .. | ||
| src | ||
| Dockerfile.5.md | ||
| README.md | ||
| docker-build.1.md | ||
| docker-config-json.5.md | ||
| docker-run.1.md | ||
| docker.1.md | ||
| dockerd.8.md | ||
| generate.go | ||
| import.go | ||
| 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