filelocations

Documentation

Overview

Documents important file paths used by the system

Index

• Variables
• type Root
  • func WithRoot(root string) Root
  • func (b Root) App(appName string) string
  • func (b Root) Checkout(sysID string) string
  • func (b Root) CheckoutsDir() string
  • func (b Root) Diff(sysID string) string
  • func (b Root) DiffWork() string
  • func (b Root) Root() string

Variables

var (
	Sysroot = WithRoot("/sysroot")
)

Types

type Root

type Root struct {
	// contains filtered or unexported fields
}

represents base path like "/sysroot" under which all subdirs are resolved from. this is roughly analogous to `$prefix` in filesystem hierarchies.

func WithRoot

func WithRoot(root string) Root

use non-default sysroot location. this is roughly analogous to `$prefix` in filesystem hierarchies.

func (Root) App

func (b Root) App(appName string) string

"/sysroot/apps/<appName>"

func (Root) Checkout

func (b Root) Checkout(sysID string) string

"/sysroot/apps/OS-checkout/<sysid>"

func (Root) CheckoutsDir

func (b Root) CheckoutsDir() string

"/sysroot/apps/OS-checkout"

func (Root) Diff

func (b Root) Diff(sysID string) string

"/sysroot/apps/OS-diff/<sysID>"

func (Root) DiffWork

func (b Root) DiffWork() string

This is referenced from initramfs (when mounting the overlay).

"/sysroot/apps/OS-diff-work"

func (Root) Root

func (b Root) Root() string

"/sysroot" please use only as-is (don't use this to derive other values)