package mirage

  1. Overview
  2. Docs
The MirageOS library operating system

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (8)

Authors

  1. T
    Thomas Gazagnaire
  2. A
    Anil Madhavapeddy
  3. Gabriel Radanne
  4. M
    Mindy Preston
  5. T
    Thomas Leonard
  6. N
    Nicolas Ojeda Bar
  7. D
    Dave Scott
  8. D
    David Kaloper
  9. H
    Hannes Mehnert
  10. R
    Richard Mortier

Maintainers

  1. A
    anil@recoil.org
  2. T
    thomas@gazagnaire.org

Sources

mirage-4.9.0.tbz
sha256=0c07d59eb52dc3d1506eb4121c4953104a12df79d08a0f0923c9b71e7474a026
sha512=666bf9ee20c9f9de058441f252f4f40ceec6a9ffd00e5cd3b7bfa9532fd65000aeb8a83f9e55586be98d0a86ea72f2dda94e924608135e3d63441359505de58a

doc/mirage.functoria/Functoria/Package/index.html

Module Functoria.PackageSource

Representation of opam packages.

Sourcetype scope = [
  1. | `Switch
  2. | `Monorepo
]

The scope of package installation:

  • Switch: installed with opam.
  • Monorepo: locally fetched along unikernel sources.
Sourcetype t

The type for opam packages.

Sourceval 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.

Sourceval with_scope : scope:scope -> t -> t

with_scope t returns t with chosen installation location.

Sourceval name : t -> string

name t is t's opam name.

Sourceval key : t -> string

key t is t's key (concatenation of name and installation scope).

Sourceval scope : t -> scope

scope t is t's installation scope.

Sourceval pin : t -> (string * string) option

pin t is Some (name_version, r) iff t is pinned to the repository r.

Sourceval build_dependency : t -> bool

build_dependency t is true iff t is a build-time dependency.

Sourceval libraries : t -> string list

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.

Sourceval max_versions : t -> string list

max_versions is the set of maximum versions of t which are required.

Sourceval min_versions : t -> string list

min_versions is the set minimum versions of t which are required.

Sourceval merge : t -> t -> t option

merge x y is merges the information of x and y. The result is None if name x != name y.

Sourceval pp : ?surround:string -> t Fmt.t

pp is the pretty-printer for packages.

Sourcemodule Set : sig ... end