keywords

type Index [2]string

type Indices []Index

type Inherit int

type Keyword struct {
	Section string
	Option  string
	Attr    string

	// Scopable means the keyword can have a different value on nodes, drpnodes, encapnodes or a specific node.
	Scopable bool

	// Required means the keyword mean be set, and thus disregards the default value.
	Required bool

	// Converter is the name of a registered routine converting a string into the keyword expected type.
	Converter string

	// Text is a text explaining the role of the keyword.
	Text string

	// DefaultText is a text explaining the default value.
	DefaultText string

	// Example demonstrates the keyword usage.
	Example string

	// Default is the value returned when the non-required keyword is not set.
	Default string

	// DefaultOption is the name of the option looked up in the
	// DEFAULT section if the keyword is not set. If not set,
	// the string in the Option field is looked up in the DEFAULT
	// section.
	DefaultOption string

	// Candidates is the list of accepted values. An empty list.
	Candidates []string

	// Depends is a list of key-value conditions to meet to accept this keyword in a config.
	Depends []keyop.T

	// Kind limits the scope of this keyword to the object with kind matching this mask.
	Kind naming.Kinds

	// Provisioning is set to true for keywords only used for resource provisioning
	Provisioning bool

	// Types limits the scope of the keyword to sections with matching type value
	Types []string

	// Aliases defines alternate names of the keyword.
	Aliases []string

	// Inherit defines weither DEFAULT.<name> overrides <rid>.<name> (Head2Leaf), or
	// <rid>.<name> overrides DEFAULT.<name> (Leaf2Head, the default), or only <rid>.<name>
	// is used (Leaf).
	Inherit Inherit

	// Deprecated is the release where the keyword has been deprecated. Users can
	// expect the keyword to be unsupported in the next release.
	Deprecated string

	// ReplacedBy means the keyword is deprecated but another keyword can be used instead.
	ReplacedBy string
}

type Store []Keyword