package git

  1. Overview
  2. Docs
package git
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module GitSource

Sourcemodule Error : sig ... end
Sourcemodule Helper : sig ... end

The Helper module should mnot be used by the client but only by maintainers of ocaml-git. It provides useful functions to interact with any I/O operations.

Sourcemodule Blob : sig ... end

A Git Blob object.

Sourcemodule Commit : sig ... end

A Git Commit object.

Sourcemodule Tree : sig ... end

A Git Tree object.

Sourcemodule Tag : sig ... end

A Git Tag object.

Sourcemodule Reference : sig ... end

The Git Reference module.

Sourcemodule User : sig ... end
Sourcemodule Value : sig ... end

The Value module which represents the Git object.

Sourcemodule Fanout : sig ... end

Implementation of a fanout table (which orders value like the IDX file).

Sourcemodule Bucket : sig ... end

A bucket is a simple option array to contain something. When the bucket is full and you try to add a new value, we erase the oldest one.

Sourcemodule Traverse_bfs : sig ... end
Sourcemodule Gc : sig ... end
Sourcemodule Object_graph : sig ... end
Sourcemodule Negociator : sig ... end
Sourcemodule Revision : sig ... end
Sourcemodule Capability : sig ... end

Capabilities module.

Sourcemodule Sync : sig ... end

The synchronization commands to a git repository.

Sourcemodule Smart : sig ... end
Sourcemodule Loose : sig ... end
Sourcemodule Pack_info : sig ... end
Sourcemodule Pack_engine : sig ... end
Sourcemodule Packed_refs : sig ... end
Sourcemodule Pack : sig ... end

PACK serializer implementation.

Sourcemodule Unpack : sig ... end

Decoder of the PACK file.

Sourcemodule Index_pack : sig ... end

Index pack implementation (serialization/unserialization).

Sourcemodule Mem : sig ... end

The memory back-end of Git.

Sourcemodule Store : sig ... end

Implementation of a Git stores.

Sourcemodule Inflate : sig ... end
Sourcemodule Deflate : sig ... end
Sourcemodule Buffer : sig ... end

An implementation of the Buffer module but with Cstruct.t.

Sourcemodule Hash : sig ... end
Sourcemodule Gri : sig ... end
Sourcemodule Tcp : sig ... end
Sourcemodule Path : sig ... end

Purpose of this module is little bit hard to understand. Indeed, in the previous version of ocaml-git, we used Fpath to have a good abstraction of path in UNIX and Windows systems. However, Git keeps in some ways (INDEX file specially) the UNIX path semantic (tree and reference use it too). So, Path is an abstraction (Git-path) to keep UNIX path semantic (and the separator "/"). However, we used it in few cases.

Sourcemodule type FILE = sig ... end
Sourcemodule type MAPPER = sig ... end
Sourcemodule type DIR = sig ... end
Sourcemodule type FS = sig ... end
Sourcemodule type DIGEST = sig ... end
Sourcemodule type HASH = sig ... end
Sourcemodule type S = sig ... end