Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BuildFlags ¶
type BuildFlags struct { AutoDep shared.DefaultTrue `yaml:"autodep,omitempty"` AVX2 shared.DefaultFalse `yaml:"avx2,omitempty"` Clang shared.DefaultTrue `yaml:"clang,omitempty"` CCache shared.DefaultFalse `yaml:"ccache,omitempty"` Debug shared.DefaultTrue `yaml:"debug,omitempty"` Devel shared.DefaultFalse `yaml:"devel,omitempty"` Emul32 shared.DefaultFalse `yaml:"emul32,omitempty"` Extract shared.DefaultTrue `yaml:"extract,omitempty"` LAStrip shared.DefaultTrue `yaml:"lastrip,omitempty"` LibSplit shared.DefaultTrue `yaml:"libsplit,omitempty"` Networking shared.DefaultFalse `yaml:"networking,omitempty"` Optimize []string `yaml:"optimize,omitempty"` Strip shared.DefaultTrue `yaml:"strip,omitempty"` }
BuildFlags are special options that configure the build process
func (BuildFlags) Convert ¶
func (flags BuildFlags) Convert() internal.BuildFlags
Convert translates a v3.BuildFlags to an internal.BuildFlags
func (*BuildFlags) Modify ¶
func (flags *BuildFlags) Modify(changes internal.BuildFlags)
Modify translates an internal.BuildFlags to a v3.BuildFlags
type BuildStages ¶
type BuildStages struct { Setup string `yaml:"setup,omitempty"` Build string `yaml:"build,omitempty"` Profile string `yaml:"profile,omitempty"` Check string `yaml:"check,omitempty"` Install string `yaml:"install"` }
BuildStages represent the scripted commands to execute for each stage of the build process
func (BuildStages) Convert ¶
func (stages BuildStages) Convert() internal.BuildStages
Convert translate a v3.BuildStags to an internal.BuildStages
func (*BuildStages) Modify ¶
func (stages *BuildStages) Modify(changes internal.BuildStages)
Modify translate an internal.BuildStags to a v3.BuildStages
type PackageDeps ¶
type PackageDeps struct { Replaces array.ListMap `yaml:"replaces,omitempty"` Conflicts array.ListMap `yaml:"conflicts,omitempty"` Build []yaml.Node `yaml:"build,omitempty"` Check []yaml.Node `yaml:"check,omitempty"` Run array.ListMap `yaml:"run,omitempty"` }
PackageDeps includes the dependencies required at Build, Check, and Run time
func NewPackageDeps ¶ added in v0.1.5
func NewPackageDeps() PackageDeps
NewPackageDeps retuns an empty PackageDeps
func (PackageDeps) Convert ¶
func (deps PackageDeps) Convert() internal.PackageDeps
Convert translates a v3.PackageDeps to an internal.PackageDeps
func (*PackageDeps) Modify ¶
func (deps *PackageDeps) Modify(changes internal.PackageDeps)
Modify translates an internal.PackageDeps to a v3.PackageDeps
type PackageYML ¶
type PackageYML struct { YPKG int `yaml:"YPKG"` Name string `yaml:"name"` Version string `yaml:"version"` Release uint `yaml:"release"` Source []shared.Source `yaml:"source"` Homepage string `yaml:"homepage,omitempty"` License shared.Licenses `yaml:"license"` Component string `yaml:"component"` Components array.Map `yaml:"components,omitempty"` Summary string `yaml:"summary"` Summaries array.Map `yaml:"summaries,omitempty"` Description string `yaml:"description"` Descriptions array.Map `yaml:"descriptions,omitempty"` Dependencies PackageDeps `yaml:"deps,omitempty"` Flags BuildFlags `yaml:"flags,omitempty"` Environment string `yaml:"environment,omitempty"` Stages BuildStages `yaml:",inline"` Permanent array.ListMap `yaml:"permanent,omitempty"` Patterns array.ListMap `yaml:"patterns,omitempty"` // contains filtered or unexported fields }
PackageYML is the v3 representation of the Package YML specification
func NewPackage ¶
func NewPackage(f *os.File) *PackageYML
NewPackage creates a new Package with an optional file argument
func (*PackageYML) Close ¶
func (p *PackageYML) Close()
Close close the file descriptor for this PackageYML
func (*PackageYML) Convert ¶
func (p *PackageYML) Convert() (pkg *internal.PackageYML, err error)
Convert translates a v3.PackageYML to an internal.Package.YML
func (*PackageYML) File ¶
func (p *PackageYML) File() *os.File
File returns a pointer to the underlying file record
func (*PackageYML) Load ¶
func (p *PackageYML) Load(path string, mode int) error
Load populates a v2 PackageYML by reading in the contents from a specific filepath
func (*PackageYML) Modify ¶
func (p *PackageYML) Modify(pkg internal.PackageYML) error
Modify converts an internal.PackageYML to a v2.PackageYML
func (*PackageYML) Save ¶
func (p *PackageYML) Save() error
Save writes any changes to this PackageYML to the currently open file descriptor