unikraft

Documentation

Index

• Constants
• func ComponentTypes() map[string]ComponentType
• func PlaceComponent(workdir string, t ComponentType, name string) (string, error)
• type ComponentType
  • func GuessTypeNameVersion(input string) (ComponentType, string, string, error)
  • func (ct ComponentType) Plural() string

Constants

const (
	// Environmental variables recognized by Unikraft's build system.
	UK_NAME        = "CONFIG_UK_NAME"
	UK_DEFNAME     = "CONFIG_UK_DEFNAME"
	UK_CONFIG      = "CONFIG_UK_CONFIG"
	UK_FULLVERSION = "CONFIG_UK_FULLVERSION"
	UK_CODENAME    = "CONFIG_UK_CODENAME"
	UK_ARCH        = "CONFIG_UK_ARCH"
	UK_BASE        = "CONFIG_UK_BASE"
	UK_APP         = "CONFIG_UK_APP"
	UK_DEFCONFIG   = "UK_DEFCONFIG"

	// Filenames which represent ecosystem files
	Config_uk     = "Config.uk"
	Makefile_uk   = "Makefile.uk"
	Exportsyms_uk = "exportsyms.uk"
)

Functions

func ComponentTypes

func ComponentTypes() map[string]ComponentType

func PlaceComponent

func PlaceComponent(workdir string, t ComponentType, name string) (string, error)

PlaceComponent is a universal source of truth for identifying the path to place a component

Types

type ComponentType

type ComponentType string

const (
	ComponentTypeUnknown ComponentType = "unknown"
	ComponentTypeCore    ComponentType = "core"
	ComponentTypeArch    ComponentType = "arch"
	ComponentTypePlat    ComponentType = "plat"
	ComponentTypeLib     ComponentType = "lib"
	ComponentTypeApp     ComponentType = "app"
)

func GuessTypeNameVersion

func GuessTypeNameVersion(input string) (ComponentType, string, string, error)

GuessNameAndType attempts to parse the input string, which could be formatted such that its type, name and version are present

func (ComponentType) Plural

func (ct ComponentType) Plural() string