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

A message for the user

User messages are styled document that can be printed to the console or in the log file.

module Style : sig ... end

Symbolic styles that can be used inside messages. These styles are later converted to actual concrete styles depending on the output device. For instance, when printed to the terminal they are converted to ansi terminal styles (Ansi_color.Style.t list values).

type t = {

loc : Stdune__.Loc0.t option;
paragraphs : Style.t Pp.t list;
hints : Style.t Pp.t list;

}

A user message.contents composed of an optional file location and a list of paragraphs.

The various paragraphs will be printed one after the other and will all start at the beginning of a line. They are all wrapped inside a Pp.box.

When hints are provided, they are printed as last paragraphs and prefixed with "Hint:". Hints should give indication to the user for how to fix the issue.

val pp : t -> Style.t Pp.t

module Print_config : sig ... end

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

Construct a user message from a list of paragraphs.

The first paragraph is prefixed with prefix inside the box. prefix should not end with a space as a space is automatically inserted by make if necessary.

val print : ?config:Print_config.t -> t -> unit

Print to stdout (not thread safe)

val prerr : ?config:Print_config.t -> t -> unit

Print to stderr (not thread safe)

val did_you_mean : string -> candidates:string list -> Style.t Pp.t list

Produces a "Did you mean ...?" hint