Module B0_memo_cli

Command line interface fragments and logic.

module Hash : sig ... end

B0_hash interaction.

module File_cache : sig ... end

B0_zero.File_cache interaction.

module Op : sig ... end

B0_zero.Op interaction.

module Log : sig ... end

B0_memo_log interaction

Memo feedback

val pp_op_howto : B0_zero.Op.t B0_std.Fmt.t

pp_op_howto formats instructions on how to get more information about an operation. This is "b0-log --id %d".

val pp_leveled_feedback : ?sep:unit B0_std.Fmt.t -> ?op_howto:B0_zero.Op.t B0_std.Fmt.t -> output_op_level:B0_std.Log.level -> output_ui_level:B0_std.Log.level -> level:B0_std.Log.level -> [ B0_memo.feedback | B0_zero.Exec.feedback ] B0_std.Fmt.t

pp_leveled_feedback ~sep ~op_howto ~output_op_level ~output_ui_level ~level ppf is formatter for memo feedback:

The formatter op_howto should format a way to got more information about an operation, default to pp_op_howto.

TODO. It's a bit unclear what "ui" is here.

Memo parameters

val trash_dirname : string

trash_dirname is ".trash", a suggested trash directoy name.

Jobs

val get_jobs : jobs:int option -> int

get_jobs ~jobs determines a maximal number of spawns. If jobs is None then B0_std.Os.Cpu.logical_count is used.

val jobs : ?opts:string list -> ?docs:string -> ?doc:string -> ?doc_none:string -> ?env:Cmdliner.Cmd.Env.info -> unit -> int option Cmdliner.Term.t

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

  • opts are the cli options to specify it, defaults to ["j";"jobs"].
  • docs is where the option is documented, defaults to Cmdliner.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 jobs_var.
val jobs_var : Cmdliner.Cmd.Env.info

jobs_env is "B0_JOBS".