gitweb

Documentation

Index

• Variables
• type CommitInfo
• type Config
• type Repo
  • func NewRepo(fp string, cloneURL *url.URL, commits uint) (*Repo, error)
  • func (r *Repo) Description() (string, error)
  • func (r *Repo) ReadState(fp string) error
  • func (r *Repo) Tip() (*object.Commit, error)
  • func (r *Repo) Walk(fn WalkFunc) error
  • func (r *Repo) WriteState(fp string) error
• type RepoFile
  • func (f *RepoFile) FilePath() string
  • func (f *RepoFile) IsDir() bool
  • func (f *RepoFile) IsSubmodule() bool
  • func (f *RepoFile) Name() string
  • func (f *RepoFile) PathElements() []string
• type RepoPage
  • func (r *RepoPage) Blob() (*object.File, error)
  • func (r *RepoPage) Commits() (*CommitInfo, error)
  • func (r *RepoPage) Files() ([]RepoFile, error)
  • func (r *RepoPage) Readme() (string, error)
  • func (r *RepoPage) Submodule(file *RepoFile) (*object.File, error)
• type WalkFunc

Variables

var (
	ExpectedDirectory = errors.New("Expected directory")
	ExpectedSubmodule = errors.New("Expected submodule")
	ExpectedRegular   = errors.New("Expected regular file")
)

Types

type CommitInfo

type CommitInfo struct {
	Commits []*object.Commit
	Total   uint
}

type Config

type Config struct {
	HeaderExtra template.HTML
}

type Repo

type Repo struct {
	Conf  Config
	Path  string
	Title string
	URL   string
	// contains filtered or unexported fields
}

func NewRepo

func NewRepo(fp string, cloneURL *url.URL, commits uint) (*Repo, error)

func (*Repo) Description

func (r *Repo) Description() (string, error)

func (*Repo) ReadState

func (r *Repo) ReadState(fp string) error

func (*Repo) Tip

func (r *Repo) Tip() (*object.Commit, error)

func (*Repo) Walk

func (r *Repo) Walk(fn WalkFunc) error

func (*Repo) WriteState

func (r *Repo) WriteState(fp string) error

type RepoFile

type RepoFile struct {
	Path string // Slash separated path
	// contains filtered or unexported fields
}

RepoFile represents information for a single file/blob.

func (*RepoFile) FilePath

func (f *RepoFile) FilePath() string

func (*RepoFile) IsDir

func (f *RepoFile) IsDir() bool

func (*RepoFile) IsSubmodule

func (f *RepoFile) IsSubmodule() bool

func (*RepoFile) Name

func (f *RepoFile) Name() string

func (*RepoFile) PathElements

func (f *RepoFile) PathElements() []string

type RepoPage

type RepoPage struct {
	*Repo

	// Underlying file which is present on this page.
	CurrentFile RepoFile
	// contains filtered or unexported fields
}

func (*RepoPage) Blob

func (r *RepoPage) Blob() (*object.File, error)

func (*RepoPage) Commits

func (r *RepoPage) Commits() (*CommitInfo, error)

func (*RepoPage) Files

func (r *RepoPage) Files() ([]RepoFile, error)

func (*RepoPage) Readme

func (r *RepoPage) Readme() (string, error)

func (*RepoPage) Submodule

func (r *RepoPage) Submodule(file *RepoFile) (*object.File, error)

type WalkFunc

type WalkFunc func(string, *RepoPage) error