vcs

Documentation

Overview

Package vcs implements functions for interacting with version control systems.

Index

• Variables
• func GetRepository(dirname string) (string, error)
• func MetadataFolder(vcs VCS) string
• type VCS
  • func In(dirname string) (VCS, error)
  • func Nearest(dirname string) (VCS, string, error)

Variables

var (
	ErrNoVCSInDir     = errors.New("could not find VCS repository in directory")
	ErrNoNearestVCS   = errors.New("could not find nearest VCS repository in directory")
	ErrUnsupportedVCS = errors.New("VCS type is not supported")
)

Errors that occur when finding VCS repositories.

var Types = [4]VCS{
	Subversion,
	Git,
	Mercurial,
	Bazaar,
}

Functions

func GetRepository

func GetRepository(dirname string) (string, error)

GetRepository returns the location of the repository containing dirname, ErrNoNearestVCS if none is found, or errors.ErrNotImplemented if an unsupported VCS is found.

func MetadataFolder

func MetadataFolder(vcs VCS) string

Types

type VCS

type VCS int

VCS represents a type of version control system.

const (
	Subversion VCS
	Git
	Mercurial
	Bazaar
)

func In

func In(dirname string) (VCS, error)

In returns the type of VCS repository rooted at a directory, or ErrNoVCSInDir if none is found.

func Nearest

func Nearest(dirname string) (VCS, string, error)

Nearest returns the type and directory of the nearest VCS repository containing the directory, or ErrNoNearestVCS if none is found.