From fa3ac2d37032583a7c1171c24d71fbf93e330acc Mon Sep 17 00:00:00 2001 From: Matthew Heon Date: Wed, 25 Jun 2014 12:04:59 -0400 Subject: [PATCH] Fixed manpage generation script and README Update md2man script to generate manpages inside docs/man/ directory. Update usage documentation in the readme to point to the new docs/man path. Update Ubuntu makefile to use new path to manpages Docker-DCO-1.1-Signed-off-by: Matthew Heon (github: mheon) --- docs/man/README.md | 8 ++++---- docs/man/md2man-all.sh | 4 ++-- hack/make/ubuntu | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/man/README.md b/docs/man/README.md index d49b39b7a2..d04d82454f 100644 --- a/docs/man/README.md +++ b/docs/man/README.md @@ -51,7 +51,7 @@ saving you from dealing with Pandoc and dependencies on your own computer. ## Building the Fedora / Pandoc image -There is a Dockerfile provided in the `docker/contrib/man/md` directory. +There is a Dockerfile provided in the `docker/docs/man` directory. Using this Dockerfile, create a Docker image tagged `fedora/pandoc`: @@ -61,11 +61,11 @@ Using this Dockerfile, create a Docker image tagged `fedora/pandoc`: Once the image is built, run a container using the image with *volumes*: - docker run -v //docker/contrib/man:/pandoc:rw \ - -w /pandoc -i fedora/pandoc /pandoc/md/md2man-all.sh + docker run -v //docker/docs/man:/pandoc:rw \ + -w /pandoc -i fedora/pandoc /pandoc/md2man-all.sh The Pandoc Docker container will process the Markdown files and generate -the man pages inside the `docker/contrib/man/man1` directory using +the man pages inside the `docker/docs/man/man1` directory using Docker volumes. For more information on Docker volumes see the man page for `docker run` and also look at the article [Sharing Directories via Volumes] (http://docs.docker.io/use/working_with_volumes/). diff --git a/docs/man/md2man-all.sh b/docs/man/md2man-all.sh index def876f47a..12d84de232 100755 --- a/docs/man/md2man-all.sh +++ b/docs/man/md2man-all.sh @@ -17,6 +17,6 @@ for FILE in *.md; do # skip files that aren't of the format xxxx.N.md (like README.md) continue fi - mkdir -p "../man${num}" - pandoc -s -t man "$FILE" -o "../man${num}/${name}" + mkdir -p "./man${num}" + pandoc -s -t man "$FILE" -o "./man${num}/${name}" done diff --git a/hack/make/ubuntu b/hack/make/ubuntu index 75202eace6..c55123fb7a 100644 --- a/hack/make/ubuntu +++ b/hack/make/ubuntu @@ -50,7 +50,7 @@ bundle_ubuntu() { docs/man/md2man-all.sh -q manRoot="$DIR/usr/share/man" mkdir -p "$manRoot" - for manDir in docs/man?; do + for manDir in docs/man/man?; do manBase="$(basename "$manDir")" # "man1" for manFile in "$manDir"/*; do manName="$(basename "$manFile")" # "docker-build.1"