version

Documentation

Index

• Variables
• type JSONVersion
• type LibraryDetailsJSON

Variables

var SourceURL = "https://github.com/philpennock/character"

SourceURL is so that the version command identifies where this came from. It can be overriden at link time, but is not expected to be.

var VersionString string

VersionString is expected to be set by the linker during build. If make(1) is used for build, this will happen.

Types

type JSONVersion

type JSONVersion struct {
	Version         string `json:"version"`
	Name            string `json:"name"`
	ArgvInvokedName string `json:"argv_invoked_name"`
	URL             string `json:"url"`

	Go struct {
		Runtime string `json:"runtime"`
	} `json:"go"`

	// The Library is keyed by the name of a library and each item includes
	// unstructed lines of version data from that library; we wrap it in an
	// extra layer so that if there's more per-library structure _available_
	// for some libraries in future, we don't need to restructure our output.
	//
	// Theoretically two functions might report the same name, but since that's
	// from our library handling, that would be our mistake.
	Library map[string]LibraryDetailsJSON `json:"library"`

	ModuleVersion map[string]string `json:"module_version"`
	BuildSetting  map[string]string `json:"build_setting"`
}

JSONVersion provides a publicly guaranteed backwards-compatible machine-parseable JSON version. Fields can be added, but must not be removed, and must not be frivolously switched to be empty.

type LibraryDetailsJSON

type LibraryDetailsJSON struct {
	Lines []string `json:"lines"`
}