docker-cli/scripts/docs/generate-man.sh

#!/usr/bin/env bash
# Generate man pages for docker/cli
set -eu -o pipefail

mkdir -p ./man/man1

if ! command -v go-md2man &> /dev/null; then
	# yay, go install creates a binary named "v2" ¯\_(ツ)_/¯
	go build -o "/go/bin/go-md2man" ./vendor/github.com/cpuguy83/go-md2man/v2
fi

# Generate man pages from cobra commands
go build -o /tmp/gen-manpages github.com/docker/cli/man
/tmp/gen-manpages --root "$(pwd)" --target "$(pwd)/man/man1"

# Generate legacy pages from markdown
./man/md2man-all.sh -q
Convert script shebangs from "#!/bin/bash" to "#!/usr/bin/env bash" This is especially important for distributions like NixOS where `/bin/bash` doesn't exist, or for MacOS users who've installed a newer version of Bash than the one that comes with their OS. Signed-off-by: Andrew "Tianon" Page <admwiggin@gmail.com> 2017-02-13 11:01:54 -08:00			`#!/usr/bin/env bash`
Run docs and man generation in CI Also cleanup the scripts a bit to be more consistent, and fail on errors. Signed-off-by: Daniel Nephin <dnephin@docker.com> 2017-06-14 13:42:58 -07:00			`# Generate man pages for docker/cli`
			`set -eu -o pipefail`
Add a script to generate man pages from cobra commands. Use the generate.sh script instead of md2man directly. Update Dockerfile for generating man pages. Signed-off-by: Daniel Nephin <dnephin@docker.com> 2016-06-09 11:33:28 -04:00
			`mkdir -p ./man/man1`

Rename bin/md2man to bin/go-md2man 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> 2020-12-16 10:19:43 +07:00			`if ! command -v go-md2man &> /dev/null; then`
generate-man.sh: Only build md2man if it's not installed Distributions uses generate-man.sh to create man pages, however it only assumes a container environment and attempts to build binaries towards `/go` which might be an illegal path in `fakeroot`. This patch ensures we only build `md2man` from the vendored sources if the command is not present. This allows distributions to supply thier packaged `md2man`. Signed-off-by: Morten Linderud <morten@linderud.pw> 2020-12-09 23:06:18 +01:00			`# yay, go install creates a binary named "v2" ¯\_(ツ)_/¯`
Rename bin/md2man to bin/go-md2man 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> 2020-12-16 10:19:43 +07:00			`go build -o "/go/bin/go-md2man" ./vendor/github.com/cpuguy83/go-md2man/v2`
generate-man.sh: Only build md2man if it's not installed Distributions uses generate-man.sh to create man pages, however it only assumes a container environment and attempts to build binaries towards `/go` which might be an illegal path in `fakeroot`. This patch ensures we only build `md2man` from the vendored sources if the command is not present. This allows distributions to supply thier packaged `md2man`. Signed-off-by: Morten Linderud <morten@linderud.pw> 2020-12-09 23:06:18 +01:00			`fi`
Add scripts and targets for manpages and yamldocs Signed-off-by: Tibor Vass <tibor@docker.com> 2017-05-10 18:24:32 -07:00
Add a script to generate man pages from cobra commands. Use the generate.sh script instead of md2man directly. Update Dockerfile for generating man pages. Signed-off-by: Daniel Nephin <dnephin@docker.com> 2016-06-09 11:33:28 -04:00			`# Generate man pages from cobra commands`
fix manpages script Signed-off-by: Tibor Vass <tibor@docker.com> 2017-06-06 04:59:50 +00:00			`go build -o /tmp/gen-manpages github.com/docker/cli/man`
Add scripts folder to shellcheck Signed-off-by: Jean-Pierre Huynh <jean-pierre.huynh@ounet.fr> 2017-07-18 13:17:17 +01:00			`/tmp/gen-manpages --root "$(pwd)" --target "$(pwd)/man/man1"`
Add a script to generate man pages from cobra commands. Use the generate.sh script instead of md2man directly. Update Dockerfile for generating man pages. Signed-off-by: Daniel Nephin <dnephin@docker.com> 2016-06-09 11:33:28 -04:00
			`# Generate legacy pages from markdown`
			`./man/md2man-all.sh -q`