search

david415 / HoneyBadger

Quantum Insert detector/recorder
GNU General Public License v3.0
305 stars 39 forks source link

add man page and API docs to debian source package #91

Open david415 opened 8 years ago

david415 commented 8 years ago

Perhaps our sphinx docs should be in the master branch on a docs directory. API docs should also be built in the source package.

Look at existing golang debian packages for implementation details.

david415 commented 8 years ago

while adding a basic help2man man page i noticed the package build fails horribly, probably because an incorrect GOPATH where no dependencies are installed:

dh build --buildsystem=golang --with=golang
   dh_testdir -O--buildsystem=golang
   debian/rules override_dh_auto_configure
make[1]: Entering directory '/home/human/gopath/src/github.com/david415/HoneyBadger'
dh_auto_configure
        mkdir -p obj-x86_64-linux-gnu
make[1]: Leaving directory '/home/human/gopath/src/github.com/david415/HoneyBadger'
   debian/rules override_dh_auto_build
make[1]: Entering directory '/home/human/gopath/src/github.com/david415/HoneyBadger'
cd obj-x86_64-linux-gnu && GOPATH=$PWD go install -tags 'debian' -v \
  github.com/david415/HoneyBadger/cmd/honeyBadger \
  github.com/david415/HoneyBadger/cmd/honeybadgerReportTool
src/github.com/david415/HoneyBadger/types/flow.go:27:2: cannot find package "github.com/google/gopacket" in any of:
        /usr/lib/go/src/pkg/github.com/google/gopacket (from $GOROOT)
        /home/human/gopath/src/github.com/david415/HoneyBadger/obj-x86_64-linux-gnu/src/github.com/google/gopacket (from $GOP
ATH)
src/github.com/david415/HoneyBadger/drivers/afpacket.go:26:2: cannot find package "github.com/google/gopacket/afpacket" in an
y of:
        /usr/lib/go/src/pkg/github.com/google/gopacket/afpacket (from $GOROOT)
        /home/human/gopath/src/github.com/david415/HoneyBadger/obj-x86_64-linux-gnu/src/github.com/google/gopacket/afpacket (
from $GOPATH)