package mirage
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=ade8c410b2de3997c4a513f53f6c990dac6af508161e20df01b64fa7975ca5be
sha512=42fddf09be84c4251417145b88d4f63b41db1b29c9622b2b4e4508e31146f227a16875e670da96251208745f79a42f0b7d2bd8b44b883a705381b4c97a4255b8
doc/mirage.functoria/Functoria/Package/index.html
Module Functoria.Package
Source
Representation of opam packages.
The scope of package installation:
- Switch: installed with opam.
- Monorepo: locally fetched along unikernel sources.
The type for opam packages.
val v :
?scope:scope ->
?build:bool ->
?sublibs:string list ->
?libs:string list ->
?min:string ->
?max:string ->
?pin:string ->
?pin_version:string ->
string ->
t
v ~scope ~build ~sublibs ~libs ~min ~max ~pin opam
is a package
. Build
indicates a build-time dependency only, defaults to false
. The library name is by default the same as opam
, you can specify ~sublibs
to add sublibraries (e.g. ~sublibs:["mirage"] "foo"
will result in the library name ["foo.mirage"]
, and ~sublibs:[""; "mirage"] "foo"
will result in the library names ["foo";"foo.mirage"]
). In case the library name is disjoint (or empty), use ~libs
. Specifying both ~libs
and ~sublibs
leads to an invalid argument. Version constraints are given as min
(inclusive) and max
(exclusive). If pin
is provided, a pin-depends is generated, pin_version
is "dev"
by default. ~scope
specifies the installation location of the package.
with_scope t
returns t with chosen installation location.
pin t
is Some (name_version, r)
iff t
is pinned to the repository r
.
libraries t
is the set of libraries (and sub-libraries) used in the package t
. For most packages, it will only contain one library whose name is name t
.
max_versions
is the set of maximum versions of t
which are required.
min_versions
is the set minimum versions of t
which are required.
merge x y
is merges the information of x
and y
. The result is None
if name x != name y
.