...
Run Format

Package vcs

import "cmd/go/internal/vcs"
Overview
Index

Overview ▾

Variables

var (
    // VCSTestRepoURL is the URL of the HTTP server that serves the repos for
    // vcs-test.golang.org.
    //
    // In tests, this is set to the URL of an httptest.Server hosting a
    // cmd/go/internal/vcweb.Server.
    VCSTestRepoURL string

    // VCSTestHosts is the set of hosts supported by the vcs-test server.
    VCSTestHosts []string

    // VCSTestIsLocalHost reports whether the given URL refers to a local
    // (loopback) host, such as "localhost" or "127.0.0.1:8080".
    VCSTestIsLocalHost func(*urlpkg.URL) bool
)

type Cmd

A Cmd describes how to use a version control system like Mercurial, Git, or Subversion.

type Cmd struct {
    Name      string
    Cmd       string     // name of binary to invoke command
    Env       []string   // any environment values to set/override
    RootNames []rootName // filename and mode indicating the root of a checkout directory

    Scheme  []string
    PingCmd string

    Status func(v *Cmd, rootDir string) (Status, error)
}

func FromDir

func FromDir(dir, srcRoot string) (repoDir string, vcsCmd *Cmd, err error)

FromDir inspects dir and its parents to determine the version control system and code repository to use. If no repository is found, FromDir returns an error equivalent to os.ErrNotExist.

func (*Cmd) IsSecure

func (v *Cmd) IsSecure(repo string) bool

func (*Cmd) Ping

func (v *Cmd) Ping(scheme, repo string) error

Ping pings to determine scheme to use.

func (*Cmd) String

func (v *Cmd) String() string

type ImportMismatchError

An ImportMismatchError is returned where metaImport/s are present but none match our import path.

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

func (ImportMismatchError) Error

func (m ImportMismatchError) Error() string

type ModuleMode

ModuleMode specifies whether to prefer modules when looking up code sources.

type ModuleMode int
const (
    IgnoreMod ModuleMode = iota
    PreferMod
)

type RepoRoot

RepoRoot describes the repository root for a tree of source code.

type RepoRoot struct {
    Repo     string // repository URL, including scheme
    Root     string // import path corresponding to the SubDir
    SubDir   string // subdirectory within the repo (empty for root)
    IsCustom bool   // defined by served <meta> tags (as opposed to hard-coded pattern)
    VCS      *Cmd
}

func RepoRootForImportPath

func RepoRootForImportPath(importPath string, mod ModuleMode, security web.SecurityMode) (*RepoRoot, error)

RepoRootForImportPath analyzes importPath to determine the version control system, and code repository to use.

type Status

Status is the current state of a local repository.

type Status struct {
    Revision    string    // Optional.
    CommitTime  time.Time // Optional.
    Uncommitted bool      // Required.
}