Module B0_ui.Memo

B00.Memo interaction.

Specifying directories and files

val b0_dir_name : string

b0_dir_name is "_b0" the default b0 directory name.

val cache_dir_name : string

cache_dir_name is ".cache" the default cache directory name in the b0 directory.

val trash_dir_name : string

trash_dir_name is ".trash" the default trash directoy name in the b0 directory.

val log_file_name : string

log_file_name is ".log" the default log file name in the b0 directory.

val b0_dir_env : string

b0_dir_env is "B0_DIR".

val cache_dir_env : string

b0_dir_env is "B0_CACHE_DIR".

val log_file_env : string

b0_dir_env is "B0_LOG_FILE".

val b0_dir : ?⁠docs:string -> ?⁠doc:string -> ?⁠doc_none:string -> ?⁠env:Cmdliner.Arg.env -> unit -> B0_std.Fpath.t option Cmdliner.Term.t

b0_dir ~doc_none ~docs ~doc ~env is a cli interface for specifying a b0 directory.

  • docs is where the option is documented, defaults to Manpage.s_common_options
  • doc is a doc string.
  • doc_none describes how the value is determined if the term is evaluates to None.
  • env is a variable that can be used to override the default value, defaults to b0_dir_env.
val cache_dir : ?⁠opts:string list -> ?⁠docs:string -> ?⁠doc:string -> ?⁠doc_none:string -> ?⁠env:Cmdliner.Arg.env -> unit -> B0_std.Fpath.t option Cmdliner.Term.t

cache_dir ~doc_none ~docs ~doc ~env is a cli interface for specifying a b0 cache directory.

  • opts are the cli options to specify it.
  • docs is where the option is documented, defaults to Manpage.s_common_options
  • doc is a doc string.
  • doc_none describes how the value is determined if the term is evaluates to None.
  • env is a variable that can be used to override the default value, defaults to cache_dir_env.
val log_file : ?⁠opts:string list -> ?⁠docs:string -> ?⁠doc:string -> ?⁠doc_none:string -> ?⁠env:Cmdliner.Arg.env -> unit -> B0_std.Fpath.t option Cmdliner.Term.t

log_file ~doc_none ~docs ~doc ~env is a cli interface for specifing a b0 log file.

  • opts are the cli options to specify it.
  • docs is where the option is documented, defaults to Manpage.s_common_options
  • doc is a doc string.
  • doc_none describes how the value is determined if the term is evaluates to None.
  • env is a variable that can be used to override the default value, defaults to cache_dir_env.
val get_b0_dir : cwd:B0_std.Fpath.t -> root:B0_std.Fpath.t -> b0_dir:B0_std.Fpath.t option -> B0_std.Fpath.t

get_b0_dir ~cwd ~root ~b0_dir determines a b0 directory. If b0_dir is Some d then this is Fpath.(cwd // d). If None then this is Fpath.(root / b0_dir_name).

val get_cache_dir : cwd:B0_std.Fpath.t -> b0_dir:B0_std.Fpath.t -> cache_dir:B0_std.Fpath.t option -> B0_std.Fpath.t

get_cache_dir ~cwd ~b0_dir ~cache_dir determines a cache directory. If cache_dir is Some d then this is Fpath.(cwd // d). If None then this is Fpath.(b0_dir / cache_dir).

val get_trash_dir : cwd:B0_std.Fpath.t -> b0_dir:B0_std.Fpath.t -> trash_dir:B0_std.Fpath.t option -> B0_std.Fpath.t

get_trash_dir ~cwd ~b0_dir ~trash_dir dtermiens a trash directory. If trash_dir is Some d then this is Fpath.(cwd // d. If None then this is Fpath.(b0_dir /trash_dir).

val get_log_file : cwd:B0_std.Fpath.t -> b0_dir:B0_std.Fpath.t -> log_file:B0_std.Fpath.t option -> B0_std.Fpath.t

get_log_file ~cwd ~b0_dir ~log_file determines a log file. If log_file is Some f then this is Fpath.(cwd // f). If None then this is Fpath.(b0_dir /log_file).

Build parameters

val jobs : ?⁠docs:string -> ?⁠env:Cmdliner.Arg.env -> unit -> int option Cmdliner.Term.t

jobs is a cli interface for specifying the maximal number of commands to spawn concurrently.

val max_spawn : jobs:int option -> unit -> int

max_spawn jobs determines a maximal number of spans. This is either, in order, jobs or B0_machine.logical_cpu_count or 1.

Build log

module Log : sig ... end