Brzo.Conf
Configuration.
module Bit : sig ... end
Configuration bits.
brzo_dir_name
is "brzo"
the default brzo directory name in the b0 directory.
The type for outcome modes.
The type for domain configurations. The pre-domain, its configured outcome name and its configuration value.
val v : action_args:string list -> background:bool -> b0_dir:B00_std.Fpath.t -> brzo_file:B00_std.Fpath.t option ->
cache_dir:B00_std.Fpath.t -> cwd:B00_std.Fpath.t -> domain_name:string option -> domain_confs:domain list ->
hash_fun:(module B00_std.Hash.T) -> jobs:int -> log_file:B00_std.Fpath.t -> log_level:B00_std.Log.level -> no_pager:bool ->
outcome_mode:outcome_mode -> pdf_viewer:B00_std.Cmd.t option -> root:B00_std.Fpath.t -> srcs_i:B00_std.Fpath.Set.t -> srcs_x:B00_std.Fpath.Set.t -> tty_cap:B00_std.Tty.cap ->
www_browser:B00_std.Cmd.t option -> unit -> t
v
constructs a configuration with given attributes. See the accessors for semantics.
val action_args : t -> string list
action_args
are the outcome action arguments.
val background : t -> bool
background
is true
if external viewers should be launched in the background.
val brzo_file : t -> B00_std.Fpath.t option
brzo_file
is the absolute path to the brzo file found at the root (if any).
val b0_dir : t -> B00_std.Fpath.t
b0_dir
is the absolute path to the b0 dir.
val cache_dir : t -> B00_std.Fpath.t
cache_dir
is the absolute path to the cache directory.
val cwd : t -> B00_std.Fpath.t
cwd
is the absolute path to the current working directoy.
val domain_name : t -> string option
domain_name
is the name of the running domain (if any).
val domain_conf : t -> (module Pre_domain.T with type Conf.t = 'a) -> (string * 'a) option
domain_conf c d
is the configuration for pre-domain d
(if any). This is the domain's selected outcome and its configuration.
val log_file : t -> B00_std.Fpath.t
log_file
is the absolute path to the build log file.
val log_level : t -> B00_std.Log.level
log_level
is the desired log level.
val hash_fun : t -> (module B00_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 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 outcome_mode : t -> outcome_mode
outcome
is the build outcome mode.
val root : t -> B00_std.Fpath.t
root
is absolute path to the brzo root.
val pdf_viewer : t -> B00_std.Cmd.t option
pdf_viewer
is the PDF viewer command.
val srcs_i : t -> B00_std.Fpath.Set.t
srcs_i
are absolute prefixes to include.
val srcs_x : t -> B00_std.Fpath.Set.t
srcs_x
are absolute prefixes to exclude.
val srcs : t -> (B00_fexts.map, string) result
srcs c
are the absolute source files path in configuration c
sorted by file extension.
val tty_cap : t -> B00_std.Tty.cap
tty_cap c
is the terminal capability to assume for output.
val www_browser : t -> B00_std.Cmd.t option
www_browser
is the WWW browser command to use.
val pp_auto : 'a B00_std.Fmt.t -> 'a option B00_std.Fmt.t
pp_auto pp
formats "<auto>"
for None
and the value with pp
otherwise.
val pp : t B00_std.Fmt.t
pp
formats configurations. Does not format domain specific configuration.
val pp_show : t B00_std.Fmt.t
pp_show
formats a header and the configuration with pp
.