Data.Git.Repository

Documentation

data Git

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

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

data HTreeEnt

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

Constructors

TreeDir Ref HTree

TreeFile Ref

gitRepoPath :: Git -> FilePath

openRepo :: FilePath -> IO Git

open a new git repository context

closeRepo :: Git -> IO ()

close a git repository context, closing all remaining fileReaders.

withRepo :: FilePath -> (Git -> IO c) -> IO c

findRepo :: IO FilePath

find the git repository from the current directory.

findReference :: Git -> Ref -> IO ObjectLocation

execute a function f with a git context.

findReferencesWithPrefix :: Git -> String -> IO [Ref]

get all the references that start by a specific prefix

findObjectRaw :: Git -> Ref -> Bool -> IO (Maybe ObjectInfo)

get an object from repository

findObjectRawAt :: Git -> ObjectLocation -> Bool -> IO (Maybe ObjectInfo)

get an object from repository

findObject :: Git -> Ref -> Bool -> IO (Maybe Object)

get an object from repository using a ref.

findObjectAt :: Git -> ObjectLocation -> Bool -> IO (Maybe Object)

get an object from repository using a location to reference it.

buildHTree :: Git -> Object -> IO HTree

build a hierarchy tree from a tree object

resolvePath :: Git -> Ref -> [ByteString] -> IO (Maybe Ref)

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

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

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.