errata

package
v1.5.49 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 24, 2025 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source
const (
	DiscoPurposeNone                        DiscoPurpose = 0
	DiscoPurposeTableAccess                              = 1 << (iota - 1)
	DiscoPurposeTableConformance                         = 1 << (iota - 1)
	DiscoPurposeTableConstraint                          = 1 << (iota - 1)
	DiscoPurposeTableLinkIndexes                         = 1 << (iota - 1)
	DiscoPurposeTableRenameHeaders                       = 1 << (iota - 1)
	DiscoPurposeTableAddMissingColumns                   = 1 << (iota - 1)
	DiscoPurposeTableReorderColumns                      = 1 << (iota - 1)
	DiscoPurposeDataTypeRename                           = 1 << (iota - 1)
	DiscoPurposeDataTypeAppendSuffix                     = 1 << (iota - 1)
	DiscoPurposeDataTypeBitmapFixRange                   = 1 << (iota - 1)
	DiscoPurposeDataTypeCommandFixDirection              = 1 << (iota - 1)
	DiscoPurposeDataTypePromoteInline                    = 1 << (iota - 1)
	DiscoPurposeNormalizeAnchor                          = 1 << (iota - 1)

	DiscoPurposeAll DiscoPurpose = DiscoPurposeTableAccess | DiscoPurposeTableConformance | DiscoPurposeTableConstraint | DiscoPurposeTableLinkIndexes | DiscoPurposeTableRenameHeaders | DiscoPurposeTableAddMissingColumns | DiscoPurposeTableReorderColumns | DiscoPurposeDataTypeAppendSuffix | DiscoPurposeDataTypeRename
)
View Source
const (
	SpecPurposeNone             SpecPurpose = 0
	SpecPurposeDataTypesBitmap              = 1 << (iota - 1)
	SpecPurposeDataTypesEnum                = 1 << (iota - 1)
	SpecPurposeDataTypesStruct              = 1 << (iota - 1)
	SpecPurposeCluster                      = 1 << (iota - 1)
	SpecPurposeDeviceType                   = 1 << (iota - 1)
	SpecPurposeCommandArguments             = 1 << (iota - 1)
	SpecPurposeDataTypesDef                 = 1 << (iota - 1)
	SpecPurposeFeatures                     = 1 << (iota - 1)

	SpecPurposeDataTypes SpecPurpose = SpecPurposeDataTypesBitmap | SpecPurposeDataTypesEnum | SpecPurposeDataTypesStruct | SpecPurposeDataTypesDef
	SpecPurposeAll       SpecPurpose = SpecPurposeDataTypes | SpecPurposeCluster | SpecPurposeDeviceType | SpecPurposeCommandArguments | SpecPurposeFeatures
)

Variables

View Source
var DefaultErrata = &Errata{}
View Source
var DocRoots = []string{
	"src/main.adoc",
	"src/appclusters.adoc",
	"src/device_library.adoc",
	"src/standard_namespaces.adoc",
}
View Source
var Erratas = map[string]*Errata{}

Functions

func LoadErrataConfig

func LoadErrataConfig(specRoot string) error

Types

type Disco

type Disco struct {
	Sections map[string]DiscoSection `yaml:"sections,omitempty"`
}

func GetDisco

func GetDisco(path string) *Disco

func (*Disco) IgnoreSection

func (d *Disco) IgnoreSection(sectionName string, purpose DiscoPurpose) bool

type DiscoPurpose

type DiscoPurpose uint64

func (DiscoPurpose) Has

func (i DiscoPurpose) Has(o DiscoPurpose) bool

func (DiscoPurpose) HasAny

func (i DiscoPurpose) HasAny(o DiscoPurpose) bool

func (DiscoPurpose) MarshalYAML

func (i DiscoPurpose) MarshalYAML() ([]byte, error)

func (*DiscoPurpose) UnmarshalYAML

func (i *DiscoPurpose) UnmarshalYAML(b []byte) error

type DiscoSection

type DiscoSection struct {
	Skip DiscoPurpose `yaml:"skip,omitempty"`
}

type Errata

type Errata struct {
	Disco    Disco    `yaml:"disco,omitempty"`
	Spec     Spec     `yaml:"spec,omitempty"`
	TestPlan TestPlan `yaml:"test-plan,omitempty"`
	SDK      SDK      `yaml:"sdk,omitempty"`
}

func GetErrata

func GetErrata(path string) *Errata

type SDK

type SDK struct {
	SkipFile                     bool                `yaml:"skip-file,omitempty"`
	SuppressAttributePermissions bool                `yaml:"suppress-attribute-permissions,omitempty"`
	ClusterDefinePrefix          string              `yaml:"cluster-define-prefix,omitempty"`
	SuppressClusterDefinePrefix  bool                `yaml:"suppress-cluster-define-prefix,omitempty"`
	DefineOverrides              map[string]string   `yaml:"override-defines,omitempty"`
	ClusterName                  string              `yaml:"cluster-name,omitempty"`
	ClusterAliases               map[string][]string `yaml:"cluster-aliases,omitempty"`
	ClusterListKeys              map[string]string   `yaml:"cluster-list-keys,omitempty"`

	WritePrivilegeAsRole bool            `yaml:"write-privilege-as-role,omitempty"`
	SeparateStructs      SeparateStructs `yaml:"separate-structs,omitempty"`

	TemplatePath string `yaml:"template-path,omitempty"`

	ClusterSplit map[string]string `yaml:"cluster-split,omitempty"`
	ClusterSkip  []string          `yaml:"cluster-skip,omitempty"`

	Domain matter.Domain `yaml:"domain,omitempty"`

	TypeNames         map[string]string `yaml:"type-names,omitempty"`
	ForceIncludeTypes []string          `yaml:"force-include-types,omitempty"`

	Types      *SDKTypes `yaml:"types,omitempty"`
	ExtraTypes *SDKTypes `yaml:"extra-types,omitempty"`
}

func GetSDK

func GetSDK(path string) *SDK

func (*SDK) OverrideConformance

func (zap *SDK) OverrideConformance(entity types.Entity) conformance.Conformance

func (*SDK) OverrideConstraint

func (zap *SDK) OverrideConstraint(entity types.Entity) constraint.Constraint

func (*SDK) OverrideDescription

func (zap *SDK) OverrideDescription(entity types.Entity, defaultDescription string) string

func (*SDK) OverrideDomain

func (zap *SDK) OverrideDomain(clusterName string, defaultDomain string) string

func (*SDK) OverrideFallback

func (zap *SDK) OverrideFallback(entity types.Entity) constraint.Limit

func (*SDK) OverrideName

func (zap *SDK) OverrideName(entity types.Entity, defaultName string) string

func (*SDK) OverridePriority

func (zap *SDK) OverridePriority(entity types.Entity, defaultPriority string) string

func (*SDK) OverrideType

func (zap *SDK) OverrideType(entity types.Entity, defaultTypeName string) string

type SDKType

type SDKType struct {
	Type         string `yaml:"type,omitempty"`
	Name         string `yaml:"name,omitempty"`
	OverrideName string `yaml:"override-name,omitempty"`
	OverrideType string `yaml:"override-type,omitempty"`
	List         bool   `yaml:"list,omitempty"`

	Fields      []*SDKType `yaml:"fields,omitempty"`
	Domain      string     `yaml:"domain,omitempty"`
	Priority    string     `yaml:"priority,omitempty"`
	Description string     `yaml:"description,omitempty"`

	Bit   string `yaml:"bit,omitempty"`
	Value string `yaml:"value,omitempty"`

	Constraint  string `yaml:"constraint,omitempty"`
	Conformance string `yaml:"conformance,omitempty"`
	Fallback    string `yaml:"fallback,omitempty"`
}

type SDKTypeCollection

type SDKTypeCollection map[string]*SDKType

type SDKTypes

type SDKTypes struct {
	Attributes  map[string]*SDKType `yaml:"attributes,omitempty"`
	Clusters    map[string]*SDKType `yaml:"clusters,omitempty"`
	Enums       map[string]*SDKType `yaml:"enums,omitempty"`
	Bitmaps     map[string]*SDKType `yaml:"bitmaps,omitempty"`
	Structs     map[string]*SDKType `yaml:"structs,omitempty"`
	Commands    map[string]*SDKType `yaml:"commands,omitempty"`
	Events      map[string]*SDKType `yaml:"events,omitempty"`
	DeviceTypes map[string]*SDKType `yaml:"device-types,omitempty"`
}

type SeparateStructs

type SeparateStructs map[string]struct{}

func (SeparateStructs) MarshalYAML

func (i SeparateStructs) MarshalYAML() ([]byte, error)

func (*SeparateStructs) UnmarshalYAML

func (i *SeparateStructs) UnmarshalYAML(b []byte) error

type Spec

type Spec struct {
	UtilityInclude bool                   `yaml:"utility-include,omitempty"`
	Sections       map[string]SpecSection `yaml:"sections,omitempty"`
	DocRoot        bool                   `yaml:"doc-root,omitempty"`
	Domain         string                 `yaml:"domain,omitempty"`
}

func GetSpec

func GetSpec(path string) *Spec

func (*Spec) IgnoreSection

func (spec *Spec) IgnoreSection(sectionName string, purpose SpecPurpose) bool

type SpecPurpose

type SpecPurpose uint64

func (SpecPurpose) Has

func (i SpecPurpose) Has(o SpecPurpose) bool

func (SpecPurpose) HasAny

func (i SpecPurpose) HasAny(o SpecPurpose) bool

func (SpecPurpose) MarshalYAML

func (i SpecPurpose) MarshalYAML() ([]byte, error)

func (*SpecPurpose) UnmarshalYAML

func (i *SpecPurpose) UnmarshalYAML(b []byte) error

type SpecSection

type SpecSection struct {
	Skip SpecPurpose `yaml:"skip,omitempty"`
}

type TestPlan

type TestPlan struct {
	TestPlanPath  string                  `yaml:"testplan-path,omitempty"`
	TestPlanPaths map[string]TestPlanPath `yaml:"testplan-paths,omitempty"`
}

type TestPlanPath

type TestPlanPath struct {
	Path string `yaml:"path,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL