attach

Documentation

Overview

Package attach handles interfacing the Brief system with a POSIX-style filesystem.

Index

• Variables
• func AbsoluteWorkingDirectory() (string, error)
• func BriefRoot() (string, error)
• func Config(fsys vfs.FS) (*config.Config, error)
• func OS(init bool) (vfs.FS, string, error)
• func Sack(fsys vfs.FS, allowsymlinks bool) (sacks.Sack, error)

Variables

var ErrBriefBoxsetAlreadyPresent = errors.New("brief boxset already present")

var ErrMalformedRoot = errors.New("malformed root") // TODO rename

var ErrNoRoot = errors.New("no root") // TODO rename

Functions

func AbsoluteWorkingDirectory

func AbsoluteWorkingDirectory() (string, error)

TODO: since we now no longer look for dotbrief but briefroot, symlinks and relative paths should no longer be an issue?

func BriefRoot

func BriefRoot() (string, error)

func Config

func Config(fsys vfs.FS) (*config.Config, error)

func OS

func OS(init bool) (vfs.FS, string, error)

init==true fails if there already is a valid root.

func Sack

func Sack(fsys vfs.FS, allowsymlinks bool) (sacks.Sack, error)

[2023-12-09, jfrech] TODO allowsymlinks is currently ignored