mirror of
https://github.com/docker/cli.git
synced 2026-01-13 18:22:35 +03:00
47775a8fa0
In order to be able to build the documentation without internet access (as is required by some distribution build systems), all of the source code needed for the build needs to be available in the source tarball. This used to be possible with the docker-cli sources but was accidentally broken with some CI changes that switched to downloading the tools (by modifying go.mod as part of the docs build script). This pattern also maked documentation builds less reproducible since the tool version used was not based on the source code version. Fixes:7dc35c03fc("validate manpages target") Fixes:a650f4ddd0("switch to cli-docs-tool for yaml docs generation") Signed-off-by: Aleksa Sarai <cyphar@cyphar.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
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