Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Line Editing for Index #2323

Merged
merged 2 commits into from
Sep 6, 2024
Merged

Line Editing for Index #2323

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
20f1f95
Expanded Irmin def. & minor line editing
christinerose Aug 28, 2024
172e089
typos and clarification
christinerose Aug 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions doc/irmin/index.mld
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
{0 Irmin}

[Irmin] is a distributed database built on the same principles as {{:https://git-scm.com} Git}. It can be used as an OCaml library that provides persistent stores with built-in snapshot, branching and reverting mechanisms.
[Irmin] is a distributed database built on the same principles as {{:https://git-scm.com} Git}. It can be used as an OCaml library that provides persistent stores with built-in snapshot, branching, merging, history tracking, and reverting mechanisms, similar to a version control system like Git, but for data rather than code.

{e Release %%VERSION%% - %%HOMEPAGE%%}

{1 Irmin API}

The [irmin] package defines the public API of [Irmin]. The entry point of the library is the module {!Irmin}.
The [irmin] package defines the public API of [Irmin]. The module {!Irmin} is this library's entry point.

{1 Backends}

Irmin is designed to use a large variety of backends. Various backends are provided:
Irmin is designed to use a large variety of backends:

- {!module:Irmin_mem}: An in-memory store provided in the [irmin] package (this package).
- {!Irmin_git}: A backend that exposes a bi-directional bridge to a Git repository proivded by the [irmin-git] package.
- {!Irmin_pack}: A space-optimiezed, on-disk store inspired by {{:https://git-scm.com/book/en/v2/Git-Internals-Packfiles} Git Packfiles} is provided in the [irmin-pack] package.
- {!Irmin_mirage}: A {{:https://mirage.io/} MirageOS} compatible store is provided in the [irmin-mirage] package.
- {!Irmin_git}: A backend that exposes a bidirectional bridge to a Git repository, provided by the [irmin-git] package.
- {!Irmin_pack}: A space-optimised, on-disk store inspired by {{:https://git-scm.com/book/en/v2/Git-Internals-Packfiles} Git Packfiles}, provided in the [irmin-pack] package.
- {!Irmin_mirage}: A {{:https://mirage.io/} MirageOS} compatible store, provided in the [irmin-mirage] package.

{1 Helpers and Internal Utilities}

{2 irmin.unix}
{2 [irmin.unix]}

The [irmin.unix] package provides [Irmin] related utilities for Unix applications.

The entry point of this library is the module {!Irmin_unix}.
The module {!Irmin_unix} is this library's entry point.

{2 irmin.data}
{2 [irmin.data]}

This package contains data structure implementations used in the implementation of Irmin. It is exposed only for internal use, and does not provide a stable API.
This package contains data structure implementations used in the implementation of Irmin. It is exposed only for internal use and does not provide a stable API.

The entry point of this library is the module {!Irmin_data}.
The module {!Irmin_data} is this library's entry point.
Loading