README

GoDoc

golang.org/x/build/maintner/godata

Package godata loads the Go project's corpus of Git, Github, and Gerrit activity into memory to allow easy analysis without worrying about APIs and their pagination, quotas, and other nuisances and limitations.

Documentation

Overview

    Package godata loads the Go project's corpus of Git, Github, and Gerrit activity into memory to allow easy analysis without worrying about APIs and their pagination, quotas, and other nuisances and limitations.

    Index

    Examples

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    func Dir

    func Dir() string

      Dir returns the directory containing the cached mutation logs.

      func Get

      func Get(ctx context.Context) (*maintner.Corpus, error)

        Get returns the Go project's corpus, containing all Git commits, Github activity, and Gerrit activity and metadata since the beginning of the project.

        Use Corpus.Update to keep the corpus up-to-date. If you do this, you must hold the read lock if reading and updating concurrently.

        The initial call to Get will download approximately 350-400 MB of data into a directory "golang-maintner" under your operating system's user cache directory. Subsequent calls will only download what's changed since the previous call.

        Even with all the data already cached on local disk, a call to Get takes approximately 5 seconds to read the mutation log into memory. For daemons, use Corpus.Update to incrementally update an already-loaded Corpus.

        The in-memory representation is about 25% larger than its on-disk size. It's currently under 500 MB.

        See https://godoc.org/golang.org/x/build/maintner#Corpus for how to walk the data structure. Enjoy.

        Example (NumComments)
        Output:
        
        

        func XdgCacheDir

        func XdgCacheDir() string

          XdgCacheDir returns the XDG Base Directory Specification cache directory.

          Types

          This section is empty.

          Source Files