package odig

  1. Overview
  2. Docs
Lookup documentation of installed OCaml packages

Install 

dune-project
 Dependency

erratique.ch Readme Changelog ISC; LicenseRef-ParaType-Free-Font-License; LicenseRef-DejaVu-fonts License Edit opam file Versions (2)

Authors

  1. T
    The odig programmers

Maintainers

  1. Daniel Bünzli

Sources

odig-0.1.0.tbz
sha512=acabe752f5010900e9fe024321d6e34cc07f395ebd18f015a00b88c4c6482645b591a83a3f088f110adaf83e062551feb800a1dbca7646cce305eb3f542cfa41

doc/odig_support/Odig_support/Pkg/index.html

Module Odig_support.PkgSource

Packages

Packages

Sourcetype name = string

The type for package names.

Sourcetype t

The type for packages.

Sourceval name : t -> name

name is the name of the package.

Sourceval path : t -> B0_std.Fpath.t

path is the path to the compilation objects of the package.

Sourceval equal : t -> t -> bool

equal p0 p1 is true if p0 and p1 point to the same package.

Sourceval compare : t -> t -> int

compare p0 p1 is a total order on packages compatible with equal.

Sourceval compare_by_caseless_name : t -> t -> int

compare_by_caseless_name p0 p1 compares p0 and p1 by name in a caseless manner.

Sourceval pp : t B0_std.Fmt.t

pp formats packages.

Sourceval pp_name : t B0_std.Fmt.t

pp_name formats package names.

Sourceval pp_version : string B0_std.Fmt.t

pp_version formats a package version.

module Set : Stdlib.Set.S with type elt = t

Package identifier sets.

module Map : Stdlib.Map.S with type key = t

Package identifier maps.

Queries

Sourceval of_dir : B0_std.Fpath.t -> t list

of_dir lib_dir are the packages found in lib_dir. This is simply all the directory names inside lib_dir and an ocaml package which points to ocamlc -where.

Sourceval by_names : ?init:t B0_std.String.Map.t -> t list -> t B0_std.String.Map.t

by_names pkgs indexes pkgs by module name and adds them to init (defaults to String.Map.empty.