Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
DockerCLI/scripts/docs/generate-man.sh

18 lines
497 B
Bash
Raw Normal View History

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 14:01:54 -05: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 16:42:58 -04: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
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 17:06:18 -05:00
if ! command -v md2man &> /dev/null; then
# yay, go install creates a binary named "v2" ¯\_(ツ)_/¯
go build -o "/go/bin/md2man" ./vendor/github.com/cpuguy83/go-md2man/v2
fi
Add scripts and targets for manpages and yamldocs Signed-off-by: Tibor Vass <tibor@docker.com>
2017-05-10 21:24:32 -04: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 00:59:50 -04: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 08:17:17 -04: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