package dune

You can search for identifiers within the package.

in-package search v0.2.0

dune._caml
- Dune_caml
dune._dune_lang
- Dune_lang
  - Ast
  - Atom
  - Conv
  - Cst
    
    Comment
  - Decoder
  - Deprecated
  - Encoder
  - File_syntax
  - Io
  - Lexer
    
    Token
  - Parser
    
    Mode
  - Template
dune._ocaml_config
- Ocaml_config
  - Origin
  - Prog_and_args
  - Value
  - Vars
dune._result
- Dune_result
  - Result
dune._stdune
- Stdune
  - Ansi_color
    
    Style
  - Appendable_list
  - Array
  - Bin
  - Bool
  - Bytes
  - Char
  - Code_error
  - Comparable
    
    Make
    
    Key
    
    Map
    
    Multi
    
    Set
  - Comparable_intf
    
    S
    
    Key
    
    Map
    
    Multi
    
    Set
  - Comparator
    
    OPS
    
    Operators
    
    X
    
    S
  - Console
    
    Display
  - Csexp
  - Digest
    
    Set
  - Dyn
    
    Encoder
  - Either
  - Env
    
    Map
    
    Multi
    
    Var
    
    Set
  - Exn
  - Exn_with_backtrace
  - Fdecl
  - Filename
  - Float
  - Fmt
  - Fn
  - Hashtbl
    
    Make
    
    Key
    
    S
  - Id
    
    Make
    
    Map
    
    Multi
    
    Set
    
    S
    
    Map
    
    Multi
    
    Set
  - Int
    
    Infix
    
    Map
    
    Multi
    
    Set
  - Interned
    
    Make
    
    Map
    
    Multi
    
    R
    
    Set
    
    Table
    
    No_interning
    
    Map
    
    Multi
    
    R
    
    Set
    
    Table
    
    S
    
    Map
    
    Multi
    
    Set
    
    Table
    
    Settings
  - Io
    
    S
    
    String_path
  - Lexbuf
  - List
  - Loc
  - Log
  - Map
    
    Key
    
    Make
    
    Key
    
    Multi
    
    S
    
    Multi
  - Monad
    
    Id
    
    S
  - Nothing
  - Option
    
    List
    
    O
  - Or_exn
  - Ordering
  - Path
    
    Build
    
    Kind
    
    L
    
    Map
    
    Multi
    
    Set
    
    Table
    
    External
    
    Map
    
    Multi
    
    Set
    
    Table
    
    L
    
    Local
    
    L
    
    Map
    
    Multi
    
    Set
    
    Table
    
    Local_gen
    
    Fix_root
    
    Map
    
    Multi
    
    Root
    
    Set
    
    Table
    
    L
    
    Map
    
    Multi
    
    Set
    
    Source
    
    L
    
    Map
    
    Multi
    
    Set
    
    Table
    
    Table
    
    Unspecified
  - Poly
  - Pp
    
    O
  - Proc
  - Result
    
    List
    
    O
    
    Option
  - Set
    
    Make
    
    Key
    
    M
    
    Multi
    
    S
  - Sexp
  - Signal
  - Staged
  - String
    
    Map
    
    Multi
    
    Set
    
    Table
  - Table
    
    Key
  - Tuple
    
    T2
  - Type_eq
  - Unit
  - Univ_map
    
    Key
  - User_error
  - User_message
    
    Print_config
    
    Style
  - User_warning
dune._wp.dune
- Wp
dune._wp.jbuilder
- Wp
dune.configurator
- Configurator
  - V1
    
    C_define
    
    Type
    
    Value
    
    Flags
    
    Pkg_config
    
    Process

Legend:
Library
Module
Module type
Parameter
Class
Class type

Error meant for humans

exception E of User_message.t

User errors are errors that users need to fix themselves in order to make progress. Since these errors are read by users, they should be simple to understand for people who are not familiar with the dune codebase.

val raise : 
  ?loc:Stdune__.Loc0.t ->
  ?hints:User_message.Style.t Pp.t list ->
  User_message.Style.t Pp.t list ->
  _

Raise a user error. The arguments are interpreted in the same way as User_message.make. The first paragraph is prefixed with "Error:".

val make : 
  ?loc:Stdune__.Loc0.t ->
  ?hints:User_message.Style.t Pp.t list ->
  User_message.Style.t Pp.t list ->
  User_message.t

Create a user error.