Module Assemblage_driver.Loader

module Loader: sig .. end

Assemble file loader.

Loader

type kind = [ `Toplevel ]

The type for kinds of loaders.

val pp_kind : Format.formatter -> kind -> unit

pp_kind ppf kind prints an unspecified representation of kind on ppf.

type t = {

kind : [ `Toplevel ];	`(*`	kind of loader.	`*)`
`ocamlfind_exec : string;`	`(*`	`ocamlfind` to use.	`*)`
`auto_lib : bool;`	`(*`	`true` to add assemblage lib to loader.	`*)`
`includes : string list;`	`(*`	includes to add to toploop execution.	`*)`
`files : Assemblage.Path.t list;`	`(*`	.ml files to load.	`*)`

}

The type for loader settings. TODO: we could add packages to the mix.

val load : ?level:Assemblage.Private.Log.level ->
       t -> unit Assemblage.Private.Cmd.result

load l loads according to settings l. level indicates with which level file loads are logged, defaults to Level.Info.

val pp : Format.formatter -> t -> unit

pp ppf l prints an unspecified representation of l on ppf.

User interface

val ui : ?kinds:kind list ->
       ?files:Assemblage.Path.t list Cmdliner.Term.t ->
       docs:string -> unit -> t Cmdliner.Term.t

ui ~docs is a Cmdliner term that defines a loader setting value either through command line options or through environment variables. An environment variable definition takes over a corresponding command line option. kinds lists the kind of loaders that should be supported, if absent all loader are supported. files defines how files to load should be parsed from the command line, default uses an optional argument.

val man_vars : ?kinds:kind list ->
       unit -> Cmdliner.Manpage.block list

man_vars is a man page fragment for the environment variables used by Assemblage_driver.Loader.ui.