package opam-lib

You can search for identifiers within the package.

in-package search v0.2.0

The OPAM library

Install

Dune Dependency

opam.ocaml.org Edit opam file Versions (1)

Authors

Maintainers

O

opam-devel@lists.ocaml.org

Sources

1.3.1.tar.gz

sha256=625767c3465219cc8799aad1449c74279b31686db0821300cfdb92fbff17e9fd

md5=e0688c0cf9a55f93ee93f62d07cf6b74

doc/opam-lib.format/OpamFile/Comp/index.html

Module `OpamFile.Comp`

Compiler version $opam/compilers/

include IO_FILE

type t

File contents

val empty : t

Empty file

val write : OpamTypes.filename -> t -> unit

Write some contents to a file

val read : OpamTypes.filename -> t

Read file contents. Raise an error if the file does not exist.

val safe_read : OpamTypes.filename -> t

Read file contents. Return empty if the file does not exist.

val read_from_channel : ?filename:OpamTypes.filename -> in_channel -> t

Read from channel.

val read_from_string : ?filename:OpamTypes.filename -> string -> t

val write_to_channel : out_channel -> t -> unit

Write to channel.

val create_preinstalled : 
  OpamTypes.compiler ->
  OpamTypes.compiler_version ->
  OpamTypes.name list ->
  (string * string * string) list ->
  t

Create a pre-installed compiler description file

val preinstalled : t -> bool

Is it a pre-installed compiler description file

val opam_version : t -> OpamTypes.opam_version

Get OPAM version

val name : t -> OpamTypes.compiler

Return the compiler name

val version : t -> OpamTypes.compiler_version

Return the compiler version

val src : t -> OpamTypes.address option

Return the url of the compiler

val kind : t -> OpamTypes.repository_kind

Return the url kind

val patches : t -> OpamTypes.filename list

Return the list of patches to apply

val configure : t -> string list

Options to give to the "./configure" command

val make : t -> string list

Options to give to the "make" command

val build : t -> OpamTypes.command list

Options to give to build the package. If this one is provided, nothing should be specified for configure and make.

val packages : t -> OpamTypes.formula

Packages to install immediately after the creation of OCaml

val env : t -> (string * string * string) list

Environment variable to set-up before running commands in the subtree

val tags : t -> string list

val with_src : t -> OpamTypes.address option -> t

val with_patches : t -> OpamTypes.filename list -> t

val with_configure : t -> string list -> t

val with_make : t -> string list -> t

val with_build : t -> OpamTypes.command list -> t

val with_packages : t -> OpamTypes.formula -> t

val to_1_0 : OpamTypes.file -> OpamTypes.file

Convert to OPAM 1.0