package b0

  1. Overview
  2. Docs
Software construction and deployment kit

Install 

dune-project
 Dependency

erratique.ch Readme Changelog ISC; BSD-2-Clause License Edit opam file Versions (2)

Authors

  1. T
    The b0 programmers

Maintainers

  1. Daniel Bünzli

Sources

b0-0.0.6.tbz
sha512=e9aa779e66c08fc763019f16d4706f465d16c05d6400b58fbd0313317ef33ddea51952e2b058db28e65f7ddb7012f328c8bf02d8f1da17bb543348541a2587f0

doc/b0.file/B0_build/index.html

Module B0_buildSource

Builds.

Centralizes the information to run and orchestrate a b0 build.

Build

Sourcetype b0_unit

The type for build units. See B0_unit.t.

Sourcetype b0_unit_set

The type for sets of build units. See B0_unit.Set.t.

Sourcetype t = B0_defs.Build_def.t

The type for builds.

Sourceval memo : t -> B0_memo.t

memo b the memoizer for the build.

Units

Sourceval must_build : t -> b0_unit_set

must_build b are the units in b that must build.

Sourceval may_build : t -> b0_unit_set

may_build b are all the units in b that may build, i.e. that can be required. This includes the elements in must_build b.

Sourceval require_unit : t -> b0_unit -> unit

require_unit b u asks to build unit u in b. This fails the memo if b is u is not in may_build.

Sourceval require_units : t -> b0_unit list -> unit

require_units b us is List.iter (require_unit b) us.

Sourceval current : t -> b0_unit

current b is b's current unit. In the build procedure of a unit this is the unit itself.

Sourceval current_meta : t -> B0_meta.t

current_meta b is B0_unit.meta (current b).

Directories

FIXME Unify the directory story with B0_action and We likely want to get rid of a few of the functions below.

Sourceval unit_dir : t -> b0_unit -> B0_std.Fpath.t

unit_dir b u is the unit build directory for unit u. This is where u should write is build artefacts.

Sourceval unit_scope_dir : t -> b0_unit -> B0_std.Fpath.t

unit_scope_dir b u is the directory of the b0 file in which u was defined. This is were unit relative paths like source files should be resolved.

Sourceval current_dir : t -> B0_std.Fpath.t

current_dir b is unit_dir b current.

Sourceval scope_dir : t -> B0_std.Fpath.t

scope_dir b is unit_scope_dir b current.

Sourceval shared_dir : t -> B0_std.Fpath.t

shared_dir b is a build directory shared by all units of the build. This is used by computations shared by units, most of the time one should rather use current_dir.

Relative file resolution

Sourceval in_unit_dir : t -> b0_unit -> B0_std.Fpath.t -> B0_std.Fpath.t

in_unit_dir b u p is Fpath.(unit_dir b u // p).

Sourceval in_unit_scope_dir : t -> b0_unit -> B0_std.Fpath.t -> B0_std.Fpath.t

in_unit_scope_dir b u p is Fpath.(unit_scope_dir b u // p))

Sourceval in_current_dir : t -> B0_std.Fpath.t -> B0_std.Fpath.t

in_current_dir b p is Fpath.(current_dir b // p)).

Sourceval in_scope_dir : t -> B0_std.Fpath.t -> B0_std.Fpath.t

in_scope_dir b p is Fpath.(scope_dir b // p)).

Sourceval in_shared_dir : t -> B0_std.Fpath.t -> B0_std.Fpath.t

in_shared_dir b p is Fpath.(shared_dir b // p)).

Store

Sourceval store : t -> B0_store.t

store b is the store for the build. Note that b itself can be found in store via the self key.

Sourceval get : t -> 'a B0_store.key -> 'a B0_std.Fut.t

get b k is B0_store.get (store b) k.

self is a store key that holds the build itself. The store returned by store has this key bound to the build.

Creating and running

Sourceval make : root_dir:B0_std.Fpath.t -> b0_dir:B0_std.Fpath.t -> variant:string -> store:B0_store.binding list -> B0_memo.t -> may_build:b0_unit_set -> must_build:b0_unit_set -> t

make ~root_dir ~b0_dir m ~may_build ~must_build

  • must_build are the build units that must be build by b.
  • may_build are the build units that may build in b. must units are automatically added to this set.
Sourceval run : t -> (unit, unit) result

run b runs the build.

Sourceval did_build : t -> b0_unit_set

did_build b are the units that did build. This is meaningless before run has finished.

_b0 directory access

Sourcemodule B0_dir : sig ... end

_b0 directory structured access.