Module Topkg_pkg

Package descriptions.

Package

type std_file
val std_file : ?install:bool -> Topkg_fpath.t -> std_file
type meta_file
val meta_file : ?lint:bool -> ?install:bool -> Topkg_fpath.t -> meta_file
type opam_file
val opam_file : ?lint:bool -> ?lint_deps_excluding:string list option -> ?install:bool -> Topkg_fpath.t -> opam_file
type t
val empty : t
val with_name_and_build_dir : ?name:string -> ?build_dir:Topkg_fpath.t -> t -> t
val v : ?delegate:Topkg_cmd.t -> ?readmes:std_file list -> ?licenses:std_file list -> ?change_logs:std_file list -> ?metas:meta_file list -> ?opams:opam_file list -> ?lint_files:Topkg_fpath.t list option -> ?lint_custom:(unit -> Topkg_result.R.msg Topkg_result.result list) -> ?distrib:Topkg_distrib.t -> ?publish:Topkg_publish.t -> ?build:Topkg_build.t -> string -> (Topkg_conf.t -> Topkg_install.t list Topkg_result.result) -> t
val name : t -> string
val delegate : t -> Topkg_cmd.t option
val readmes : t -> Topkg_fpath.t list
val change_logs : t -> Topkg_fpath.t list
val licenses : t -> Topkg_fpath.t list
val distrib : t -> Topkg_distrib.t
val codec : t Topkg_codec.t
val build_dir : t -> Topkg_fpath.t
val opam : name:string -> t -> Topkg_fpath.t
val distrib_uri : t -> string option
val distrib_prepare : t -> dist_build_dir:Topkg_fpath.t -> name:string -> version:string -> opam:Topkg_fpath.t -> opam_adds:string -> Topkg_fpath.t list Topkg_result.result
val publish_artefacts : t -> [ `Distrib | `Doc | `Alt of string ] list
val test : t -> list:bool -> tests:string list -> args:Topkg_cmd.t option -> int Topkg_result.result
val build : t -> kind:[ `Build | `Dry_run | `Raw of string list ] -> Topkg_conf.t -> Topkg_conf.os -> int Topkg_result.result
val clean : t -> Topkg_conf.os -> int Topkg_result.result
val lint_custom : t -> (unit -> Topkg_result.R.msg Topkg_result.result list) option
val lint_files : t -> Topkg_fpath.t list option
val lint_metas : t -> (Topkg_fpath.t * bool) list
val lint_opams : t -> (Topkg_fpath.t * bool * string list option) list