package obuilder

You can search for identifiers within the package.

in-package search v0.2.0

package obuilder

obuilder
- Obuilder
  - BUILDER
  - Btrfs_store
  - Build_log
  - Builder
    
    Sandbox
    
    Store
    
    _
  - Config
    
    Mount
    
    Secret
  - Context
  - Docker
  - Rsync_store
  - S
    
    BUILDER
    
    FETCHER
    
    SANDBOX
    
    STORE
  - Sandbox
  - Store_spec
  - User_temp
  - Zfs_store

Legend:
Library
Module
Module type
Parameter
Class
Class type

Store build results using rsync.

include S.STORE

type t

val root : t -> string

root t returns the root of the store.

val build : 
  t ->
  ?base:S.id ->
  id:S.id ->
  (string -> (unit, 'e) Lwt_result.t) ->
  (unit, 'e) Lwt_result.t

build t ~id fn runs fn tmpdir to add a new item to the store under key id. On success, tmpdir is saved as id, which can be used as the base for further builds, until it is expired from the cache. On failure, nothing is recorded and calling build again will make another attempt at building it. The builder will not request concurrent builds for the same id (it will handle that itself). It will also not ask for a build that already exists (i.e. for which result returns a path).

parameter base
Initialise tmpdir as a clone of base.

val delete : t -> S.id -> unit Lwt.t

delete t id removes id from the store, if present.

val result : t -> S.id -> string option Lwt.t

result t id is the path of the build result for id, if present.

val log_file : t -> S.id -> string Lwt.t

log_file t id is the path of the build logs for id. The file may not exist if the build has never been run, or failed.

val state_dir : t -> string

state_dir is the path of a directory which can be used to store mutable state related to this store (e.g. an sqlite3 database).

val cache : 
  user:Obuilder_spec.user ->
  t ->
  string ->
  (string * (unit -> unit Lwt.t)) Lwt.t

cache ~user t name creates a writeable copy of the latest snapshot of the cache name. It returns the path of this fresh copy and a function which must be called to free it when done. If the cache name does not exist, it is first created (as an empty directory, and owned by user). When the copy is released, it is snapshotted to become the new latest version of the cache, unless the cache has already been updated since it was snapshotted, in which case this writeable copy is simply discarded.

val delete_cache : t -> string -> (unit, [> `Busy ]) Lwt_result.t

delete_cache t name removes the cache name, if present. If the cache is currently in use, the store may instead return Error `Busy.

val complete_deletes : t -> unit Lwt.t

complete_deletes t attempts to wait for previously executed deletes to finish, so that the free space is accurate.

type mode =

| Copy
(*
Fast but uses more disk space.
*)
| Hardlink
(*
Slow but consumes less disk space.
*)
| Hardlink_unsafe
(*
Reasonably fast and uses less disk space, but no checksum verification. Only for testing during development, do not use in production.
*)

val create : path:string -> ?mode:mode -> unit -> t Lwt.t

create ~path ?mode () creates a new rsync store where everything will be stored under path. The mode defaults to Copy and defines how the caches are reused: Copy copies all the files, while Hardlink tries to save disk space by sharing identical files.