Data.Git.Repository

Documentation

data Git

represent a git repo, with possibly already opened filereaders for indexes and packs

Config

configRead :: Git -> IO Config

Read the Config

newtype Config

Constructors

Config [Section]

Instances

Eq Config

Show Config

data Section

Constructors

Section

Fields

sectionName :: String

sectionKVs :: [(String, String)]

Instances

Eq Section

Show Section

Trees

type HTree = [(ModePerm, ByteString, HTreeEnt)]

data HTreeEnt

hierarchy tree, either a reference to a blob (file) or a tree (directory).

Constructors

TreeDir Ref HTree

TreeFile Ref

newtype RefName

Constructors

RefName

Fields

refNameRaw :: String

Instances

Eq RefName

Ord RefName

Show RefName

IsString RefName

getCommitMaybe :: Git -> Ref -> IO (Maybe Commit)

get a specified commit

getCommit :: Git -> Ref -> IO Commit

get a specified commit but raises an exception if doesn't exists or type is not appropriate

getTreeMaybe :: Git -> Ref -> IO (Maybe Tree)

get a specified tree

getTree :: Git -> Ref -> IO Tree

get a specified tree but raise

rewrite

Arguments

:: Git

Repository

-> (Commit -> IO Commit)

Mapping function

-> Revision

revision to start from

-> Int

the number of parents to map

-> IO Ref

return the new head REF

Rewrite a set of commits from a revision and returns the new ref.

If during revision traversal (diving) there's a commit with zero or multiple parents then the traversal will stop regardless of the amount of parent requested.

calling rewrite f 2 (revisionOf d) on the following tree:

a <-- b <-- c <-- d

result in the following tree after mapping with f:

a <-- f(b) <-- f(c) <-- f(d)

buildHTree :: Git -> Tree -> IO HTree

build a hierarchy tree from a tree object

resolvePath

Arguments

:: Git

repository

-> Ref

commit reference

-> [ByteString]

paths

-> IO (Maybe Ref)

resolve the ref (tree or blob) related to a path at a specific commit ref

resolveTreeish :: Git -> Ref -> IO (Maybe Tree)

returns a tree from a ref that might be either a commit, a tree or a tag.

resolveRevision :: Git -> Revision -> IO (Maybe Ref)

try to resolve a string to a specific commit ref for example: HEAD, HEAD^, master~3, shortRef

initRepo :: FilePath -> IO ()

initialize a new repository at a specific location.

isRepo :: FilePath -> IO Bool

basic checks to see if a specific path looks like a git repo.

named refs manipulation

branchWrite

Arguments

:: Git

repository

-> RefName

the name of the branch to write

-> Ref

the reference to set

-> IO ()

Write a branch to point to a specific reference

branchList :: Git -> IO (Set RefName)

Return the list of branches

tagWrite

Arguments

:: Git

repository

-> RefName

the name of the tag to write

-> Ref

the reference to set

-> IO ()

Write a tag to point to a specific reference

tagList :: Git -> IO (Set RefName)

Return the list of branches

headSet

Arguments

:: Git

repository

-> Either Ref RefName

either a raw reference or a branch name

-> IO ()

Set head to point to either a reference or a branch name.

headGet :: Git -> IO (Either Ref RefName)

Get what the head is pointing to, or the reference otherwise