make doc problem

[NEOAdvancedTechnology]

# make doc
make -C packet testing
Checking for AVX support... AVX and AVX2
make[1]: Entering directory `/home/ec2-user/nff-go/packet'
go test
EAL: Detected 36 lcore(s)
EAL: Detected 1 NUMA nodes
EAL: Multi-process socket /var/run/dpdk/rte/mp_socket
EAL: No free hugepages reported in hugepages-1048576kB
EAL: Probing VFIO support...
EAL: PCI device 0000:00:05.0 on NUMA socket -1
EAL:   Invalid NUMA socket, default to 0
EAL:   probe driver: 1d0f:ec20 net_ena
EAL: PCI device 0000:00:06.0 on NUMA socket -1
EAL:   Invalid NUMA socket, default to 0
EAL:   probe driver: 1d0f:ec20 net_ena
EAL: PCI device 0000:00:07.0 on NUMA socket -1
EAL:   Invalid NUMA socket, default to 0
EAL:   probe driver: 1d0f:ec20 net_ena
PASS
ok      github.com/intel-go/nff-go/packet   2.290s
make[1]: Leaving directory `/home/ec2-user/nff-go/packet'
mkdir doc
godoc -analysis=type -analysis=pointer -html github.com/intel-go/nff-go/flow > doc/flow.html; godoc -analysis=type -analysis=pointer -html github.com/intel-go/nff-go/packet > doc/packet.html;
flag provided but not defined: -html
usage: godoc -http=localhost:6060
  -analysis string
        comma-separated list of analyses to perform (supported: type, pointer). See http://golang.org/lib/godoc/analysis/help.html
  -goroot string
        Go root directory (default "/usr/local/go")
  -http string
        HTTP service address (default "localhost:6060")
  -index
        enable search index
  -index_files string
        glob pattern specifying index files; if not empty, the index is read from these files in sorted order
  -index_interval duration
        interval of indexing; 0 for default (5m), negative to only index once at startup
  -index_throttle float
        index throttle value; 0.0 = no time allocated, 1.0 = full throttle (default 0.75)
  -links
        link identifiers to their declarations (default true)
  -maxresults int
        maximum number of full text search results shown (default 10000)
  -notes string
        regular expression matching note markers to show (default "BUG")
  -play
        enable playground
  -templates string
        load templates/JS/CSS from disk in this directory
  -timestamps
        show timestamps with directory listings
  -url string
        print HTML for named URL
  -v    verbose mode
  -write_index
        write index to a file; the file name must be specified with -index_files
  -zip string
        zip file providing the file system to serve; disabled if empty
flag provided but not defined: -html
usage: godoc -http=localhost:6060
  -analysis string
        comma-separated list of analyses to perform (supported: type, pointer). See http://golang.org/lib/godoc/analysis/help.html
  -goroot string
        Go root directory (default "/usr/local/go")
  -http string
        HTTP service address (default "localhost:6060")
  -index
        enable search index
  -index_files string
        glob pattern specifying index files; if not empty, the index is read from these files in sorted order
  -index_interval duration
        interval of indexing; 0 for default (5m), negative to only index once at startup
  -index_throttle float
        index throttle value; 0.0 = no time allocated, 1.0 = full throttle (default 0.75)
  -links
        link identifiers to their declarations (default true)
  -maxresults int
        maximum number of full text search results shown (default 10000)
  -notes string
        regular expression matching note markers to show (default "BUG")
  -play
        enable playground
  -templates string
        load templates/JS/CSS from disk in this directory
  -timestamps
        show timestamps with directory listings
  -url string
        print HTML for named URL
  -v    verbose mode
  -write_index
        write index to a file; the file name must be specified with -index_files
  -zip string
        zip file providing the file system to serve; disabled if empty
make: *** [doc] Error 2

# go version
go version go1.12.2 linux/amd64

[gshimansky]

Sorry, this make target is broken because it wasn't used for a while. I am fixing it, but you can have a better experience browsing automatically generated documentation online here https://godoc.org/github.com/intel-go/nff-go.

I am not sure if we still need a locally generated documentation at all because most of time online documentation is easier to use.

[gshimansky]

Also we've recently got several new pages on wiki which explain API usage: https://github.com/intel-go/nff-go/wiki/Building-Packet-Processing-Graph and https://github.com/intel-go/nff-go/wiki/Helper-API. Please take a look at them.

[gshimansky]

I've made a change #596 which removes static documentation generation because godoc tool doesn't support it any more. I updated readme to point to online version.

[NEOAdvancedTechnology]

Thanks!