package b0

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Units
Build configuration
1. Generated code
Build fragments
Metadata
Library resolution

package b0

b0
- B0_build
- B0_cli
  - Arg
- B0_cmdlet
  - Env
  - Map
  - Set
- B0_def
  - Make
    
    Map
    
    Set
    
    V
  - S
    
    Map
    
    Set
  - Scope
  - VALUE
- B0_dir
- B0_driver
  - Cli
  - Compile
  - Conf
  - Env
  - Exit
- B0_file
- B0_meta
  - Key
- B0_pack
  - Map
  - Set
- B0_unit
  - Action
  - Map
  - Set
b0.b0
- B0_b0
  - Cli
  - Def
- B0_cmd_build
- B0_cmd_cmd
- B0_cmd_cmdlet
- B0_cmd_delete
- B0_cmd_file
- B0_cmd_log
- B0_cmd_pack
- B0_cmd_root
- B0_cmd_scope
- B0_cmd_unit
- B0_main
b0.b00
- B00
  - Env
  - Memo
  - Store
  - Tool
- B000
  - Exec
  - File_cache
  - Guard
  - Op
    
    Copy
    
    Delete
    
    Map
    
    Mkdir
    
    Notify
    
    Read
    
    Set
    
    Spawn
    
    Wait_files
    
    Write
  - Reviver
  - Trash
- B000_conv
  - Op
b0.b00.kit
- B00_base64
- B00_cli
  - Arg
  - B00_std
  - Exit
  - File_cache
  - Memo
    
    Log
  - Op
- B00_cmark
- B00_editor
  - Env
- B00_fexts
- B00_findex
- B00_github
  - Auth
  - Issue
  - Pages
  - Release
  - Repo
- B00_htmlg
  - At
    
    Name
  - El
- B00_http
  - Http
  - Httpr
  - Uri
- B00_jsoo
- B00_lines
- B00_ocaml
  - Archive
  - Cobj
    
    Map
    
    Set
  - Compile
  - Conf
  - Crunch
  - Lib
    
    Name
    
    Map
    
    Set
    
    Resolver
  - Link
  - Mod
    
    Name
    
    Ref
    
    Map
    
    Set
    
    Src
    
    Deps
  - Ocamlpath
  - Tool
- B00_odoc
  - Compile
    
    Dep
    
    Writes
  - Html
    
    Dep
    
    Writes
  - Html_fragment
  - Support_files
    
    Writes
  - Theme
- B00_os
- B00_pager
  - Env
- B00_pdf_viewer
  - Env
- B00_rsync
- B00_serialk_json
  - Json
  - Jsong
  - Jsonq
- B00_serialk_sexp
  - Sexp
  - Sexpg
  - Sexpq
- B00_serialk_text
  - Tdec
  - Tloc
- B00_trace
  - Compilation_database
  - Trace_event
- B00_vcs
  - Git
  - Hg
- B00_www_browser
  - Env
b0.b00.std
- B00_std
  - Bincode
  - Char
    
    Ascii
  - Cmd
  - Fmt
  - Fpath
    
    Map
    
    Set
  - Fut
    
    Syntax
  - Hash
    
    Murmur3_128
    
    T
    
    Xxh_64
  - List
  - Log
  - Mtime
    
    Span
  - Os
    
    Cmd
    
    Cpu
    
    Time
    
    Dir
    
    Env
    
    Exit
    
    Fd
    
    File
    
    Mtime
    
    Path
  - Result
    
    Syntax
  - Rqueue
  - String
    
    Ascii
    
    Map
    
    Set
  - Tid
  - Tty
b0.kit
- B0_jsoo
- B0_kit
  - V000
- B0_ocaml
  - Meta
- B0_ocaml_eco
- B0_opam
  - Cmdlet
  - File
  - Meta
- B0_release
  - Cmdlet
  - Meta
- B0_srcs

Legend:
Library
Module
Module type
Parameter
Class
Class type

OCaml B0 file support.

Units

A few high-level build units.

val libname : string -> B00_ocaml.Lib.Name.t

libname n is n as an OCaml library name. This is shortcut for B00_ocaml.Lib.Name.v.

val exe : 
  ?wrap:(B0_unit.proc -> B0_unit.proc) ->
  ?doc:string ->
  ?meta:B0_meta.t ->
  ?action:B0_unit.action ->
  ?requires:B00_ocaml.Lib.Name.t list ->
  ?name:string ->
  string ->
  srcs:B0_srcs.sels ->
  B0_unit.t

exe n is a build unit for an executable named n (without the platform specific extension).

doc is the unit doc string.
meta is the initial metadata.
requires are the OCaml libraries required to compile the executable.
name is the name of the unit (defaults to n).
srcs are the executable sources. All files with extension .ml, .mli, .c and .h are considered for compiling and linking the executable.
wrap allows to extend the build procedure you must call the given build procedure. TODO maybe remove once we have good Build fragments.

val lib : 
  ?wrap:(B0_unit.proc -> B0_unit.proc) ->
  ?doc:string ->
  ?meta:B0_meta.t ->
  ?action:B0_unit.action ->
  ?requires:B00_ocaml.Lib.Name.t list ->
  ?name:string ->
  B00_ocaml.Lib.Name.t ->
  srcs:B0_srcs.sels ->
  B0_unit.t

lib n ~srcs is a built unit for a library named l made of sources src.

doc is the unit doc string.
meta is the initial metadata.
requires are the OCaml libraries required to compile the library.
name is the name of the build unit (default to n with . substituted by -)
srcs are the library sources. extension .ml, .mli, .c and .h are considered for compiling and linking the executable.
wrap allows to extend the build procedure you must call the given build procedure. TODO maybe remove once we have good Build fragments.

Build configuration

val conf : B00_ocaml.Conf.t B00.Store.key

conf is a memo key store with the OCaml configuration.

val version : B0_build.t -> (int * int * int * string option) B00_std.Fut.t

ocaml_version b gets B00_ocaml.Tool.Conf.version from conf.

Generated code

In a build it is desirable to know which code is being produced because if both are produced the compilers may compete to produce some of the shared build artefacts. The following store keys allow to express build code desires and determine the actual decision. Note the desires may actually be altered units that may build FIXME maybe we should stick to must.

type built_code = [

| `Byte
| `Native
| `All

]

The type indicating which code is being built.

val pp_built_code : built_code B00_std.Fmt.t

pp_built_code formats built_code values.

val wanted_code : [ built_code | `Auto ] B00.Store.key

wanted_code indicates which code should be built, default determines to `Auto. If `Auto is used and no unit that may build has specific Meta.needs_code then `Native is used if ocamlopt can be found in the memo environment and `Byte otherwise.

val built_code : built_code B00.Store.key

build_code is a memo key indicating the built code. By default determines by consulting wanted_code.

Build fragments

See TODO.

Metadata

val tag : unit B0_meta.key

tag indicates the entity is related to OCaml.

module Meta : sig ... end

Metadata keys

Library resolution

val lib_resolver : B00_ocaml.Lib.Resolver.t B00.Store.key

lib_resolver is the library resolver used by the build units defined by this module. See default_lib_resolver for the default.

val default_lib_resolver : 
  B00.Store.t ->
  B00.Memo.t ->
  B00_ocaml.Lib.Resolver.t B00_std.Fut.t

default_lib_resolver determines the default value of lib_resolver. This resolver does the following:

It first looks if the library name is defined by a unit that may be built. If that is the case it creates a library out of that build unit via lib_of_unit.
It looks into the build environment via B00_ocaml.Lib.Resolver.ocamlpath and B00_ocaml.Lib.Resolver.ocamlfind using the B0_build.shared_build_dir directory of the build.

val lib_of_unit : 
  B0_build.t ->
  B00_ocaml.Conf.t ->
  B0_unit.t ->
  B00_ocaml.Lib.t option B00_std.Fut.t

lib_of_unit b ocaml_conf u defines a library from unit u by consulting Meta.requires, Meta.library and Meta.mod_srcs. As a side effect this B0_build.require u.

val lib_resolver_build_scope : 
  B0_build.t ->
  B00_ocaml.Conf.t ->
  B00_ocaml.Lib.Resolver.scope

lib_resolver_build_scope b conf is a library resolver scope for OCaml libraries that can be built in b. For a unit u to be recognized as such it has to:

Be in the B0_build.may_build set of b.
Define the Meta.library and Meta.requires in its metadata.