builder2v1

Documentation

Index

• func BuildCreationInfoSection2_1(creatorType string, creator string, testValues map[string]string) (*v2_1.CreationInfo, error)
• func BuildFileSection2_1(filePath string, prefix string, fileNumber int) (*v2_1.File, error)
• func BuildPackageSection2_1(packageName string, dirRoot string, pathsIgnore []string) (*v2_1.Package, error)
• func BuildRelationshipSection2_1(packageName string) (*v2_1.Relationship, error)

Functions

func BuildCreationInfoSection2_1

func BuildCreationInfoSection2_1(creatorType string, creator string, testValues map[string]string) (*v2_1.CreationInfo, error)

BuildCreationInfoSection2_1 creates an SPDX Package (version 2.1), returning that package or error if any is encountered. Arguments:

• creatorType: one of Person, Organization or Tool
• creator: creator string
• testValues: for testing only; call with nil when using in production

func BuildFileSection2_1

func BuildFileSection2_1(filePath string, prefix string, fileNumber int) (*v2_1.File, error)

BuildFileSection2_1 creates an SPDX File (version 2.1), returning that file or error if any is encountered. Arguments:

• filePath: path to file, relative to prefix
• prefix: relative directory for filePath
• fileNumber: integer index (unique within package) to use in identifier

func BuildPackageSection2_1

func BuildPackageSection2_1(packageName string, dirRoot string, pathsIgnore []string) (*v2_1.Package, error)

BuildPackageSection2_1 creates an SPDX Package (version 2.1), returning that package or error if any is encountered. Arguments:

• packageName: name of package / directory
• dirRoot: path to directory to be analyzed
• pathsIgnore: slice of strings for filepaths to ignore

func BuildRelationshipSection2_1

func BuildRelationshipSection2_1(packageName string) (*v2_1.Relationship, error)

BuildRelationshipSection2_1 creates an SPDX Relationship (version 2.1) solely for the document "DESCRIBES" package relationship, returning that relationship or error if any is encountered. Arguments:

• packageName: name of package / directory