Module git

Data Types
Function Index
Function Details

Data Types

branch()

branch() = string()

change_type()

change_type() = indexed_added | indexed_modified | indexed_deleted | modified | deleted | untracked

cid()

cid() = string()

dir()

dir() = file:filename()

head()

head() = string()

lref()

lref() = {branch, branch()} | {tag, tag()} | ref()

option()

option() = no_checkout | quite | force

ref()

ref() = head() | branch() | tag() | remote() | cid()

ref_type()

ref_type() = head | tag | remote | cid | 'HEAD'

remote()

remote() = string()

repo()

repo() = url() | dir()

tag()

tag() = string()

url()

url() = string()

Function Index

add_files/2
amend_changes/1
branch/1
branches/1
branches_commits/1
checkout/2	Tries to checkout to given commit.
checkout/3
checkout_cmd/3
clone/2
clone/3
clone_cmd/3
commit/2
describe/1
diff_names/3
download/2
download/3
fetch/1	Fetches recent changes from repo.
fetch_cmd/1
get_reachable_versions/1
head/1
init/1
log_commits/1
refs/1
remote/1	List of remote entities: git remote -v.
remote/2
remote/3
remotes/1
remotes_commits/1
reset_hard/2
semver/1
status_changed_files/1
status_is_detached/1
status_is_dirty/1
tag/2
tags/1
tags_commits/1
version_tags/1
version_tags_commits/1

Function Details

add_files/2

add_files(Repo::dir(), Files::[file:filename()]) -> {ok, string()} | {error, term()}

amend_changes/1

amend_changes(Repo) -> any()

branch/1

branch(Repo::dir()) -> {ok, branch()} | detached

branches/1

branches(Repo::repo()) -> [branch()]

branches_commits/1

branches_commits(Repo::repo()) -> [{branch(), cid()}]

checkout/2

checkout(RepoDir::dir(), CommitID::ref()) -> {ok, string()} | {error, term()}

throws {unable_to_checkout, Reason}

Tries to checkout to given commit.

checkout/3

checkout(RepoDir::dir(), CommitID::ref(), Opts::[option()]) -> {ok, string()} | {error, term()}

checkout_cmd/3

checkout_cmd(RepoDir, CommitID, Opts) -> any()

clone/2

clone(RepoURL::url(), RepoPath::dir()) -> {ok, string()} | {error, term()}

throws {unable_to_clone, Reason::list()}

clone/3

clone(RepoURL::url(), RepoPath::dir(), Opts::[option()]) -> {ok, string()} | {error, term()}

clone_cmd/3

clone_cmd(RepoURL, RepoPath, Opts) -> any()

commit/2

commit(Repo, Msg) -> any()

describe/1

describe(Repo) -> any()

diff_names/3

diff_names(Repo, A, B) -> any()

download/2

download(Url::url(), Dir::dir()) -> {ok, string()} | {error, term()}

download/3

download(Url::url(), Dir::dir(), Rev::lref()) -> {ok, string()} | {error, term()}

fetch/1

fetch(RepoDir::dir()) -> {ok, string()} | {error, term()}

throws {unable_to_checkout, Reason}

Fetches recent changes from repo.

fetch_cmd/1

fetch_cmd(RepoDir) -> any()

get_reachable_versions/1

get_reachable_versions(Repo::repo()) -> [semver:semver()]

head/1

head(Repo) -> any()

init/1

init(RepoDir::dir()) -> ok | {error, any()}

log_commits/1

log_commits(Repo) -> any()

refs/1

refs(Repo::repo()) -> [{ref(), ref_type(), cid()}]

remote/1

remote(Repo::dir()) -> {ok, list()}

List of remote entities: git remote -v

remote/2

remote(RepoDir::dir(), RepoURL::url()) -> ok | {error, any()}

remote/3

remote(RepoDir::dir(), RemoteName::list(), RepoURL::url()) -> ok | {error, any()}

remotes/1

remotes(Repo::repo()) -> [remote()]

remotes_commits/1

remotes_commits(Repo::repo()) -> [{remote(), cid()}]

reset_hard/2

reset_hard(Repo, Semver) -> any()

semver/1

semver(Repo) -> any()

status_changed_files/1

status_changed_files(Repo::dir()) -> [{change_type(), file:filename()}]

status_is_detached/1

status_is_detached(Repo::dir()) -> boolean()

status_is_dirty/1

status_is_dirty(Repo::dir()) -> boolean()

tag/2

tag(Repo, Ver) -> any()

tags/1

tags(Repo::repo()) -> [tag()]

tags_commits/1

tags_commits(Repo::repo()) -> [{tag(), cid()}]

version_tags/1

version_tags(Repo::repo()) -> [semver:semver()]

version_tags_commits/1

version_tags_commits(Repo::repo()) -> [{semver:semver(), cid()}]

Generated by EDoc