buildinfo

Documentation

Overview

Package buildinfo contains build information.

Some of the exported fields may be set during compilation by passing -ldflags "-X src.elv.sh/pkg/buildinfo.Var=value" to "go build".

Index

• Constants
• Variables
• type Program
  • func (p *Program) RegisterFlags(fs *prog.FlagSet)
  • func (p *Program) Run(fds [3]*os.File, _ []string) error
• type Type
  • func (Type) IsStructMap()

Constants

const VersionBase = "0.20.1"

VersionBase identifies the version of Elvish. On the development branches, it identifies the next release.

Variables

var BuildVariant string

BuildVariant may be set during compilation to identify a particular build variant, such as a build by a specific distribution, with modified dependencies, or with a non-standard toolchain.

If non-empty, it is appended to the version string, along with a "+" prefix.

var VCSOverride string

VCSOverride may be set during compilation to "time-commit" (e.g. "20220320172241-5dc8c02a32cf") for identifying the version of development builds.

It is only needed if the automatic population of version information implemented in devVersion fails.

This variable is ignored on release branches.

var Value = Type{

	Version:   addVariant(VersionBase, BuildVariant),
	GoVersion: runtime.Version(),
}

Value contains all the build information.

Types

type Program

type Program struct {
	// contains filtered or unexported fields
}

Program is the buildinfo subprogram.

func (*Program) RegisterFlags

func (p *Program) RegisterFlags(fs *prog.FlagSet)

func (*Program) Run

func (p *Program) Run(fds [3]*os.File, _ []string) error

type Type

type Type struct {
	Version   string `json:"version"`
	GoVersion string `json:"goversion"`
}

Type contains all the build information fields.

func (Type) IsStructMap

func (Type) IsStructMap()