diff --git a/cmd/doc.go b/cmd/doc.go new file mode 100644 index 000000000..3fe01f0d1 --- /dev/null +++ b/cmd/doc.go @@ -0,0 +1,4 @@ +/* +Package cmd contains all the pilosa subcommand definitions (1 per file). +*/ +package cmd diff --git a/cmd/pilosa/main.go b/cmd/pilosa/main.go index 76173db81..1947288c7 100644 --- a/cmd/pilosa/main.go +++ b/cmd/pilosa/main.go @@ -1,3 +1,6 @@ +/* +This is the entrypoint for the Pilosa binary. +*/ package main import ( diff --git a/ctl/doc.go b/ctl/doc.go new file mode 100644 index 000000000..1cc3981c2 --- /dev/null +++ b/ctl/doc.go @@ -0,0 +1,3 @@ +// package ctl contains all pilosa subcommands other than 'server'. These are +// generally administration, testing, and debugging tools. +package ctl diff --git a/doc.go b/doc.go index 64ef0a483..e2265bef6 100644 --- a/doc.go +++ b/doc.go @@ -1,9 +1,7 @@ /* Package pilosa implements the core of the Pilosa distributed bitmap index. It -contains all the core domain objects, interfaces, and high level logic that make -pilosa work. +contains all the domain objects, interfaces, and logic that defines pilosa. */ - package pilosa diff --git a/pql/doc.go b/pql/doc.go new file mode 100644 index 000000000..abd8607a1 --- /dev/null +++ b/pql/doc.go @@ -0,0 +1,4 @@ +/* +Package pql defines the Pilosa Query Language. +*/ +package pql diff --git a/server/server.go b/server/server.go index 469b5bc3b..251a054aa 100644 --- a/server/server.go +++ b/server/server.go @@ -1,3 +1,7 @@ +// package server contains the `pilosa server` subcommand which runs Pilosa +// itself. The purpose of this package is to define an easily tested Command +// object which handles interpreting configuration and setting up all the +// objects that Pilosa needs. package server import (