package b0
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha512=e9aa779e66c08fc763019f16d4706f465d16c05d6400b58fbd0313317ef33ddea51952e2b058db28e65f7ddb7012f328c8bf02d8f1da17bb543348541a2587f0
doc/b0.memo/B0_memo_cli/index.html
Module B0_memo_cli
Source
Command line interface fragments and logic.
B0_zero.File_cache
interaction.
B0_zero.Op
interaction.
B0_memo_log
interaction
Memo feedback
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:
level
indicates the wanted feedback level, this is typically the currentB0_std.Log.level
. The following levels are treated specially (other arguments can be ignored):B0_std.Log.level.Quiet
formats nothing.B0_std.Log.level.Debug
report all completed operations withB0_zero_conv.Op.pp_line_and_ui
.
- If
level >= output_op_level
any completed operation gets logged withB0_zero_conv.Op.pp_line_and_ui
- If
level >= output_ui_ui
any completed operation gets logged withB0_zero_conv.Op.pp_ui
sep
is formatted at the end iff something is formated. Defaults toB0_std.Fmt.cut
.
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
trash_dirname
is ".trash"
, a suggested trash directoy name.
Jobs
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 toCmdliner.Manpage.s_common_options
doc
is a doc string.doc_none
describes how the value is determined if the term is evaluates toNone
.env
is a variable that can be used to override the default value, defaults tojobs_var
.
jobs_env
is "B0_JOBS"
.