package b0

You can search for identifiers within the package.

in-package search v0.2.0

Software construction and deployment kit

Install

dune-project

Dependency

erratique.ch Readme Changelog ISC; BSD-2-Clause License Edit opam file Versions (2)

Authors

T

The b0 programmers

Maintainers

Daniel Bünzli

Sources

b0-0.0.5.tbz

sha512=00a6868b4dfa34565d0141b335622a81a0e8d5b9e3c6dfad025dabfa3df2db2a1302b492953bbbce30c3a4406c324fcec25250a00b38f6d18a69e15605e3b07e

doc/b0/B0_cmdlet/Env/index.html

Module `B0_cmdlet.Env`Source

Cmdlet execution environments.

Sourcetype cmdlet = t

See B0_cmdlet.t.

Sourcetype t

The type for cmdlet execution environments.

Source

val v : 
  cwd:B0_std.Fpath.t ->
  scope_dir:B0_std.Fpath.t ->
  root_dir:B0_std.Fpath.t ->
  b0_dir:B0_std.Fpath.t ->
  cmdlet:cmdlet ->
  t

v ~cwd ~scope_dir ~root_dir ~cmdlet is an execution context with given parameters. See corresponding accessors for semantics.

Sourceval cwd : t -> B0_std.Fpath.t

cwd c is the absolute path to the current working directory.

Sourceval scope_dir : t -> B0_std.Fpath.t

scope_dir c is the absolute path to the directory of the B0 file in which the cmdlet is defined or the root directory if the cmdlet is defined the global scope.

Sourceval root_dir : t -> B0_std.Fpath.t

root_dir c is the root directory.

Sourceval b0_dir : t -> B0_std.Fpath.t

b0_dir c is the b0 directory.

Sourceval scratch_dir : t -> B0_std.Fpath.t

scratch_dir c is a shared scratch directory for cmdlets in b0_dir. The directory must be created it may not exist, it's content may be destroyed at any time and cmdlets are in charge of inventing a naming scheme to avoid collisions.

Sourceval cmdlet : t -> cmdlet

cmdlet e is the executing cmdlet.