package current_git

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t

A local Git repository.

val v : Fpath.t -> t

v path is the local Git repository at path.

val head : t -> [ `Commit of Commit_id.t | `Ref of string ] Current.t

head is the current branch ref (e.g. "/refs/heads/master").

val head_commit : t -> Commit.t Current.t

head_commit is the commit at the head of the current branch.

val commit_of_ref : t -> string -> Commit.t Current.t

commit_of_ref t gref evaluates to the commit at the head of gref. e.g. commit_of_ref t "/refs/heads/master"

val repo : t -> Fpath.t
OCaml

Innovation. Community. Security.