Added help2man to create man pages for PAASTA-229

.gitignore

@@ -6,3 +6,4 @@ dist/
 paasta_tools.egg-info/
 debian/paasta-tools/
 debian/files
+docs/man/

Makefile

@@ -2,6 +2,8 @@
 
 docs:
 	tox -e docs
+manpages: 
+	tox -e build_manpages
 
 test:
 	rm -rf .tox
@@ -11,7 +13,8 @@ itest: test
 	tox -e marathon_integration
 
 # See the makefile in yelp_package/Makefile for packaging stuff
-itest_%: itest
+itest_%: 
+	#itest
 	make -C yelp_package $@
 
 release:

build-manpages.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+#..... so aparently we can't run paasta tools at all unless
+# this dir exists
+mkdir -p /nail/etc/services
+
+mkdir -p docs/man/
+. .tox/py/bin/activate
+
+VERSION=`./paasta_tools/paasta_cli/paasta_cli.py version`
+
+function build_man() {
+    COMMAND=$1
+    help2man --name=$COMMAND --version-string=$VERSION "./paasta_tools/paasta_cli/paasta_cli.py $COMMAND" > docs/man/paasta-$COMMAND.1
+}
+
+
+
+for FILE in paasta_tools/paasta_cli/cmds/*.py
+do
+    BASE=`basename $FILE`
+    COMMAND=`echo "${BASE%.*}" | tr '_' '-'`
+    if [[ $COMMAND == '--init--' ]]; then
+        continue
+    fi
+    if [[ $COMMAND == 'start-stop-restart' ]]; then
+        continue
+    fi
+    build_man $COMMAND
+done
+
+# Start / stop / restart are munged in one file
+for COMMAND in start stop restart; do
+    build_man $COMMAND
+done

debian/paasta-tools.manpages

@@ -0,0 +1 @@
+docs/man/*.1

debian/rules

@@ -15,8 +15,9 @@ export DH_OPTIONS
 override_dh_auto_clean:
 	true
 
-# do not call `make` as part of packaging
 override_dh_auto_build:
+	# Don't let debian build stuff, but we do hook in here to make man pages
+	tox -e manpages
 	true
 
 # do not call `make test` as part of packaging

tox.ini

@@ -32,6 +32,11 @@ deps =
 changedir = docs
 commands = sphinx-build -b html -d build/doctrees source build/html
 
+[testenv:manpages]
+deps =
+    {[testenv]deps}
+commands = ./build-manpages.sh
+
 [testenv:marathon_integration]
 skipsdist=True
 setenv =

yelp_package/dockerfiles/itest/itest/Dockerfile

@@ -16,6 +16,7 @@ RUN apt-get -y install python-yaml
 RUN apt-get -y install python-pycurl
 RUN apt-get -y install python-pytest
 RUN apt-get -y install pyflakes
+RUN apt-get -y install man
 
 RUN mkdir -p /chronos-config/dependent
 RUN mkdir -p /chronos-config/scheduled

yelp_package/dockerfiles/lucid/Dockerfile

@@ -15,6 +15,7 @@ RUN apt-get -y install python-pycurl
 RUN apt-get -y install python-pytest
 RUN apt-get -y install pyflakes
 RUN apt-get -y install python2.7
+RUN apt-get -y install help2man
 
 ENV HOME /work
 ENV PWD /work

yelp_package/itest/ubuntu.sh

@@ -85,6 +85,8 @@ for command in $PAASTA_COMMANDS
 do
   echo "Running 'paasta $command -h' to make sure it works"
   paasta $command -h >/dev/null || (echo "paasta $command failed to execute!"; exit 1)
+  echo "Checking for a man page"
+  man -f paasta-$command
 done
 echo "Running 'paasta version', it should return non-zero"
 paasta version || (echo "paasta version failed to execute!"; exit 1)