package dune

  1. Overview
  2. Docs
Fast, portable and opinionated build system

Install 

dune-project
 Dependency

github.com Readme Changelog MIT License Edit opam file Versions (22)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

dune-1.6.3.tbz
sha256=bfd52160d88578c404af1267abfba6eb4928988e51aef0e92dbebdea1607ae36
md5=1212a36547d25269675d767c38fecf5f

doc/dune._stdune/Stdune/Path/index.html

Module Stdune.Path

module Local : sig ... end

In the current workspace (anything under the current project root)

module External : sig ... end

In the outside world

module Kind : sig ... end
type t
val to_sexp : t Sexp.Encoder.t
val compare : t -> t -> Ordering.t

a directory is smaller than its descendants

val equal : t -> t -> bool
module Set : sig ... end
module Map : Map.S with type key = t
module Table : Hashtbl.S with type key = t
val of_string : ?error_loc:Loc.t -> string -> t
val to_string : t -> string
val to_string_maybe_quoted : t -> string

to_string_maybe_quoted t is maybe_quoted (to_string t)

val kind : t -> Kind.t
val root : t
val is_root : t -> bool
val is_managed : t -> bool
val relative : ?error_loc:Loc.t -> t -> string -> t
val of_filename_relative_to_initial_cwd : string -> t

Create an external path. If the argument is relative, assume it is relative to the initial directory dune was launched in.

val to_absolute_filename : t -> string

Convert a path to an absolute filename. Must be called after the workspace root has been set. root is the root directory of local paths

val reach : t -> from:t -> string
val reach_for_running : ?from:t -> t -> string

from defaults to Path.root

val descendant : t -> of_:t -> t option
val is_descendant : t -> of_:t -> bool
val append : t -> t -> t
val append_local : t -> Local.t -> t
val basename : t -> string
val parent : t -> t option
val parent_exn : t -> t
val is_suffix : t -> suffix:string -> bool
val extend_basename : t -> suffix:string -> t
val extract_build_context : t -> (string * t) option

Extract the build context from a path. For instance, representing paths as strings:

  extract_build_context "_build/blah/foo/bar" = Some ("blah", "foo/bar")
val extract_build_context_dir : t -> (t * t) option

Same as extract_build_context but return the build context as a path:

  extract_build_context "_build/blah/foo/bar" = Some ("_build/blah", "foo/bar")
val drop_build_context : t -> t option

Drop the "_build/blah" prefix

val drop_build_context_exn : t -> t
val drop_optional_build_context : t -> t

Drop the "_build/blah" prefix if present, return t otherwise

val sandbox_managed_paths : sandbox_dir:t -> t -> t

Transform managed paths so that they are descedant of sandbox_dir.

val explode : t -> string list option
val explode_exn : t -> string list
val build_dir : t

The build directory

val is_in_build_dir : t -> bool

is_in_build_dir t = is_descendant t ~of:build_dir

val is_in_source_tree : t -> bool

is_in_build_dir t = is_managed t && not (is_in_build_dir t)

val is_alias_stamp_file : t -> bool
val is_strict_descendant_of_build_dir : t -> bool

is_strict_descendant_of_build_dir t = is_in_build_dir t && t <> build_dir

val split_first_component : t -> (string * t) option

Split after the first component if t is local

val insert_after_build_dir_exn : t -> string -> t
val exists : t -> bool
val readdir_unsorted : t -> string list
val is_directory : t -> bool
val rmdir : t -> unit
val rm_rf : t -> unit
val mkdir_p : t -> unit
val extension : t -> string
val split_extension : t -> t * string
val pp : Format.formatter -> t -> unit
val pp_debug : Format.formatter -> t -> unit
val build_dir_exists : unit -> bool
val ensure_build_dir_exists : unit -> unit
val set_build_dir : Kind.t -> unit

set the build directory. Can only be called once and must be done before paths are converted to strings elsewhere.

val in_source : string -> t

paths guaranteed to be in the source directory

val of_local : Local.t -> t
val set_root : External.t -> unit

Set the workspace root. Can onyl be called once and the path must be absolute

module Internal : sig ... end

Internal use only

module L : sig ... end
val local_part : t -> Local.t

Return the "local part" of a path. For local paths (in build directory or source tree), this returns the path itself. For external paths, it returns a path that is relative to the current directory. For example, the local part of /a/b is ./a/b.