naming

Documentation

Overview

Package naming includes various naming nuances

Index

• Constants
• type Args
• type Naming
  • func New(args Args) *Naming

Constants

const (
	// ContainerArchiveDir constant represents where on container will
	// archive directory be mounted
	ContainerArchiveDir = "/archive"
	// ContainerBuildDir constant represents where on container will
	// build directory be mounted
	ContainerBuildDir = "/build"
	// ContainerSourceDir constant represents where on container will
	// source directory be mounted
	ContainerSourceDir = "/build/source"
	// ContainerCacheDir constant represents where on container will
	// cache directory be mounted
	ContainerCacheDir = "/var/cache/apt"
)

Types

type Args

type Args struct {
	// Prefix is the program name
	Prefix string

	// Source is the name of source package
	Source string
	// Version is the version of source package
	Version string
	// Upstream is the upstream version of source package
	Upstream string
	// Target is the target distribution the package is building for
	Target string

	// SourceBaseDir is a directory where source lives
	SourceBaseDir string
	// BuildBaseDir is a directory where all build dirs are stored
	BuildBaseDir string
	// CacheBaseDir is a directory where all cache dirs are stored
	CacheBaseDir string
	// PackagesBaseDir is a directory where all build packages are stored
	PackagesBaseDir string
}

Args struct holds information about package base directories and prefix

type Naming

type Naming struct {
	// Args embedded here for quick reference
	Args

	// Container name
	Container string
	// Image name
	Image string

	// SourceDir is an absolute path where source lives
	SourceDir string
	// SourceParentDir is an absolute path where orig upstream tarball lives
	SourceParentDir string
	// BuildDir is an absolute path where build artifacts are stored
	BuildDir string
	// CacheDir is an absolute path where apt cache is stored
	CacheDir string
	// PackagesDir is an absolute path where
	// all built packages are stored
	PackagesDir string
	// PackagesTargetDir is an absolute path where
	// all built packages for given target are stored
	PackagesTargetDir string
	// PackagesSourceDir is an absolute path where
	// all built packages for given source are stored
	PackagesSourceDir string
	// PackagesVersionDir is an absolute path where
	// all built packages for given source version are stored
	PackagesVersionDir string
}

Naming struct holds various information naming information about package, container, image, directories

func New

func New(args Args) *Naming

New creates new instance of Naming struct