package mirage

  1. Overview
  2. Docs
On This Page
  1. Devices
package mirage
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Functoria.InfoSource

Information about the final application.

Sourcetype t

The type for information about the final application.

Sourceval config_file : t -> Fpath.t

config_file t is the configuration file of the application.

Sourceval name : t -> string

name t is the name of the application.

Sourceval project_name : t -> string

project_name t is the project name.

Sourceval main : t -> Fpath.t

main t is the name of the main application file.

Sourceval output : t -> string option

output t is the name of t's output. Derived from name if not set.

Sourceval with_output : t -> string -> t

with_output t o is similar to t but with the output set to Some o.

Sourceval libraries : t -> string list

libraries t are the direct OCamlfind dependencies.

Sourceval packages : t -> Package.t list

packages t are the opam package dependencies by the project.

Sourceval opam : t -> extra_repo:(string * string) list -> install:Install.t -> opam_name:string -> Opam.t

opam scope t is t'opam file to install in the scope context.

Sourceval keys : t -> Key.t list

keys t is the list of keys which can be used to configure t.

Sourceval runtime_args : t -> Runtime_arg.t list

runtime_args t is the list of command-line arguments which can be used to configure t at runtime.

Sourceval context : t -> Context.t

parsed t is a value representing the command-line argument being parsed.

Sourceval get : t -> 'a Key.key -> 'a

get i k is the value associated with k in context i.

Sourceval v : ?config_file:Fpath.t -> packages:Package.t list -> keys:Key.t list -> runtime_args:Runtime_arg.t list -> context:Context.t -> ?configure_cmd:string -> ?pre_build_cmd:(Fpath.t option -> string) -> ?lock_location:(Fpath.t option -> string -> string) -> build_cmd:(Fpath.t option -> string) -> src:[ `Auto | `None | `Some of string ] -> project_name:string -> string -> t

create context n r contains information about the application being built.

Sourceval pp : bool -> t Fmt.t

Devices

Sourceval t : t Type.t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct