package b0

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Default file names
Configurations
Derived data
Setup

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_list
- 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
  - B0_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.kit
- B0_expect
  - Outcome
- B0_jsoo
- B0_kit
  - V000
- B0_ocaml
  - Meta
- B0_ocaml_eco
- B0_opam
  - Cmdlet
  - File
  - Meta
- B0_release
  - Cmdlet
  - Meta
- B0_srcs
b0.std
- B0_std
  - Bincode
  - Char
    
    Ascii
  - Cmd
  - Fmt
  - Fpath
    
    Map
    
    Set
  - Fut
    
    Syntax
  - Hash
    
    T
    
    Xxh3_128
    
    Xxh3_64
  - List
  - Log
  - Mtime
    
    Span
  - Os
    
    Cmd
    
    Cpu
    
    Time
    
    Dir
    
    Env
    
    Exit
    
    Fd
    
    File
    
    Mtime
    
    Path
  - Result
    
    Syntax
  - Rqueue
  - String
    
    Ascii
    
    Map
    
    Set
  - Tty
  - Type
    
    Id

Legend:
Library
Module
Module type
Parameter
Class
Class type

Driver configuration.

Default file names

val b0_file_name : string

b0_file_name is "B0.ml" the default B0 file name.

val drivers_dir_name : string

driver_dir_name is ".drivers" the default directory for drivers in the b0 directory.

Configurations

type t

The type for configurations.

val v : 
  b0_dir:B0_std.Fpath.t ->
  b0_file:B0_std.Fpath.t option ->
  cache_dir:B0_std.Fpath.t ->
  cwd:B0_std.Fpath.t ->
  code:B00_ocaml.Conf.code option ->
  hash_fun:(module B0_std.Hash.T) ->
  jobs:int ->
  log_level:B0_std.Log.level ->
  no_pager:bool ->
  tty_cap:B0_std.Tty.cap ->
  unit ->
  t

v constructs a configuration with given attributes. See the accessors for semantics.

val b0_file : t -> B0_std.Fpath.t option

b0_file is the absolute path to the B0 file (if any).

val b0_dir : t -> B0_std.Fpath.t

b0_dir is the absolute path to the b0 directory.

val cache_dir : t -> B0_std.Fpath.t

cache_dir is the absolute path to the cache directory.

val cwd : t -> B0_std.Fpath.t

cwd is the absolute path to the current working directory.

val code : t -> B00_ocaml.Conf.code option

code is the code to which the driver is compiled.

val hash_fun : t -> (module B0_std.Hash.T)

hash_fun is the hash function to use for build caching.

val jobs : t -> int

jobs is the maximal number of spawns allowed.

val log_level : t -> B0_std.Log.level

log_level is the desired log level.

val memo : t -> (B00.Memo.t, string) result

memo is the memoizer for the configuration.

val no_pager : t -> bool

no_pager indicates no paging is desired on stdout.

val tty_cap : t -> B0_std.Tty.cap

tty_cap is the terminal capability to assume for outputs.

Derived data

val get_b0_file : t -> (B0_std.Fpath.t, string) result

get_b0_file provides an error message if b0_file is None.

Setup

val setup_with_cli : 
  b0_dir:B0_std.Fpath.t option ->
  b0_file:B0_std.Fpath.t option ->
  cache_dir:B0_std.Fpath.t option ->
  code:B00_ocaml.Conf.code option ->
  hash_fun:(module B0_std.Hash.T) option ->
  jobs:int option ->
  log_level:B0_std.Log.level option ->
  no_pager:bool ->
  tty_cap:B0_std.Tty.cap option option ->
  unit ->
  (t, string) result

setup_with_cli determines and setups a configuration with the given values. These are expected to have been determined by environment variables and command line arugments.