Documentation ¶
Overview ¶
package build implements a more convenient interface for building zoekt indices.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var DefaultDir = filepath.Join(os.Getenv("HOME"), ".zoekt")
Functions ¶
This section is empty.
Types ¶
type Builder ¶
type Builder struct {
// contains filtered or unexported fields
}
Builder manages (parallel) creation of uniformly sized shards.
func NewBuilder ¶
NewBuilder creates a new Builder instance.
type Options ¶
type Options struct { // IndexDir is a directory that holds *.zoekt index files. IndexDir string // SizeMax is the maximum file size SizeMax int // Parallelism is the maximum number of shards to index in parallel Parallelism int // ShardMax sets the maximum corpus size for a single shard ShardMax int // RepositoryDescription holds names and URLs for the repository. RepositoryDescription zoekt.Repository // SubRepositories is a path => sub repository map. SubRepositories map[string]*zoekt.Repository // Path to exuberant ctags binary to run CTags string // If set, ctags must succeed. CTagsMustSucceed bool // Write memory profiles to this file. MemProfile string }
Options sets options for the index building.
func (*Options) IndexVersions ¶
func (o *Options) IndexVersions() []zoekt.RepositoryBranch
IndexVersions returns the versions as present in the index, for implementing incremental indexing.
func (*Options) SetDefaults ¶
func (o *Options) SetDefaults()
SetDefaults sets reasonable default options.
Click to show internal directories.
Click to hide internal directories.