Index of values


(++) [Odig.Private.Dot]
s ++ s' is sequence s' concatenated to s.
(++) [Odig.Private.Html]
s ++ s' is sequence s' concatenated to s.
(++) [Odig.Private.Json]
s ++ s' is sequence s' concatenated to s.

A
a [Odig.Private.Html]
add_inc [Odig.Private.Ocamltop]
add_inc dir add dir to the include path.
announce [Odig.Private.Top]
announce ppf outputs a message that odig's toplevel support was setup.
arr [Odig.Private.Json]
arr els is an array whose values are defined by the elements els.
att [Odig.Private.Dot]
att k v is attribute k with value v.
att [Odig.Private.Html]
att a v is an attribute a with value v.
atts [Odig.Private.Dot]
atts kind atts are attributes atts for kind.
attv [Odig.Private.Html]
attv v is an attribute value v.
authors [Odig.Pkg]
authors p is p's authors: field.

B
body [Odig.Private.Html]
bool [Odig.Private.Json]
bool b is b as a JSON boolean value.
buffer_add [Odig.Private.Dot]
buffer_add b g adds the dot graph g to b.
buffer_add [Odig.Private.Html]
buffer_add ~doc_type b h adds the sequence h to b.
buffer_add [Odig.Private.Json]
buffer_add b j adds the JSON value j to b.

C
cache_status [Odig.Pkg]
cache_status p is p's cache status.
cached_pkgs_names [Odig.Conf]
cached_pkgs_names c is the set of names of the packages that are cached in c.
cachedir [Odig.Pkg]
cachedir p is p's cache directory, located somewhere in the configuration's Odig.Conf.cachedir.
cachedir [Odig.Conf]
cachedir c is c's odig cache directory.
change_logs [Odig.Pkg]
change_logs p are the change log files of p.
class_ [Odig.Private.Html]
class_ c is a class attribute c.
classify [Odig.Pkg]
clear_cache [Odig.Pkg]
clear_cache p deletes p's Odig.Pkg.cachedir.
clear_cache [Odig.Conf]
clear_cache c deletes c's cache directory.
cma [Odig.Cobj.Cmo]
cma cmo is an enclosing cma file (if any).
cmas [Odig.Cobj]
cmas s is the list of cmas contained in s.
cmi_deps [Odig.Cobj.Cmxa]
cmi_deps ~conflict cmxa is the list of cmi imported by the cmxs in the library.
cmi_deps [Odig.Cobj.Cmx]
cmi_deps cmx is the list of imported module interfaces names with their digest, if known.
cmi_deps [Odig.Cobj.Cma]
cmi_deps ~conflict cma is the list of cmi imported by the cmos in the library.
cmi_deps [Odig.Cobj.Cmt]
cmi_deps cmt is the list of imported module interfaces names with their digest, if known.
cmi_deps [Odig.Cobj.Cmo]
cmi_deps cmo is the list of imported module interfaces names with their digest, if known.
cmi_digest [Odig.Cobj.Cmx]
cmi_digest cmx is the digest of the module interface of the implementation.
cmi_digest [Odig.Cobj.Cmt]
cmi_digest cmt is the digest of the module interface of the implementation.
cmi_digest [Odig.Cobj.Cmo]
cmi_digest cmo is the digest of the module interface of the implementation.
cmi_digests [Odig.Cobj.Cmxa]
cmi_digests ~init cmxa adds to init (defaults to Digest.Map.empty) the cmi digests of the modules defined by cmxa mapped to their module name.
cmi_digests [Odig.Cobj.Cma]
cmi_digests ~init cma adds to init (defaults to Digest.Map.empty) the cmi digests of the modules defined by cma mapped to their module name.
cmi_for_interface [Odig.Cobj]
cmi_for_interface ~resolve i dep is the resolution resolve of cmis matching module interface dep in i.
cmis [Odig.Cobj]
cmis s is the list of cmis contained in s.
cmis_for_interface [Odig.Cobj.Index]
cmi_for_interface i q is a list of cmis whose module interface matches q.
cmo_for_interface [Odig.Cobj]
cmo_for_interface ~resolve i dep is the resolution resolve of cmos matching module interface dep in i.
cmos [Odig.Cobj.Cma]
cmos cma are the cmos contained in the cma.
cmos [Odig.Cobj]
cmos ~files s is the list of cmos contained in s.
cmos_for_interface [Odig.Cobj.Index]
cmo_for_interface i d is a list of cmo whose module interface matches q.
cmtis [Odig.Cobj]
cmtis s is the list of cmtis contained in s.
cmtis_for_interface [Odig.Cobj.Index]
cmti_for_interface i q is a list of cmtis whose module interface matches q.
cmts [Odig.Cobj]
cmts s is the list of cmts contained in s.
cmts_for_interface [Odig.Cobj.Index]
cmxs_for_interface i cmx is a list of cmx objects whose module interface matches q.
cmx_deps [Odig.Cobj.Cmx]
cmx_deps cmx is the list of imported module implementations names with their digest, if known.
cmx_for_interface [Odig.Cobj]
cmx_for_interface ~resolve i dep is the resolution resolve of cmxs matching module interface dep in i.
cmxa [Odig.Cobj.Cmx]
cmxa cmx is an enclosing cmxa file (if any).
cmxas [Odig.Cobj]
cmxa s is the list of cmxas contained in s.
cmxs [Odig.Cobj.Cmxa]
cmxs cmxa are the cmxs contained in the cmxa.
cmxs [Odig.Cobj]
cmxs ~files s is the list of cmxs contained in s.
cmxs_for_interface [Odig.Cobj.Index]
cmxs_for_interface i cmx is a list of cmx objects whose module interface matches q.
cmxss [Odig.Cobj]
cmxss s is the list of cmxss contained in s.
cobjs [Odig.Pkg]
cobjs p are p's compilation objects.
cobjs [Odig.Cobj.Cmxa]
cobjs are C objects needed files needed for linking.
cobjs_trail [Odig.Private.Pkg]
cobjs_trail p is a trail for Cobjs.t.
code [Odig.Private.Html]
color [Odig.Private.Dot]
color c is a color attribute l.
compare [Odig.Pkg]
compare p p' is a total order on p and p''s names.
compile [Odig.Ocamldoc]
compile ~ocamldoc ~force p compiles the .ocodoc files from the .mli and .cmi files of package p.
compile [Odig.Odoc]
compile ~odoc ~force p compiles the .odoc files from the .cmti files of package p.
conf [Odig_cli]
conf () is a Cmdliner term that has all the options to setup an odig configuration.
conf [Odig.Pkg]
conf p is the configuration in which p was found.
conf_cobj_index [Odig.Pkg]
conf_cobj_cobjs c is an index for all compilation objects in present in packages of configuration c.
copts [Odig.Cobj.Cmxa]
copts are options for the C linker.
custom [Odig.Cobj.Cma]
custom cma is true if it requires custom mode linking.
custom_cobjs [Odig.Cobj.Cma]
cma_custom_cobjs are C objects files needed for custom mode linking.
custom_copts [Odig.Cobj.Cma]
cma_custom_copts are C link options for custom mode linking.

D
data [Odig.Private.Html]
data d is character data d.
dd [Odig.Private.Html]
default_file [Odig.Conf]
default_file is the default configuration file.
depopts [Odig.Pkg]
deps p are p's OPAM optional dependencies.
deps [Odig.Pkg]
deps p are p's OPAM dependencies if opt is true (default) includes optional dependencies.
deps [Odig.Cobj.Cmti]
deps cmti is the list of imported module interfaces with their digest, if known.
deps [Odig.Cobj.Cmi]
deps cmi is the list of imported module interfaces names with their digest, if known.
digest [Odig.Cobj.Cmx]
digest cmx is the digest of the implementation.
digest [Odig.Cobj.Cmti]
digest cmti is the digest of the module interface.
digest [Odig.Cobj.Cmi]
digest cmi is the digest of the module interface.
dir_is_package [Odig.Pkg]
dir_is_package dir is Some name if a package named name is detected in directory dir.
div [Odig.Private.Html]
dl [Odig.Private.Html]
dllibs [Odig.Cobj.Cma]
cma_dllibs are dynamically loaded C libraries for ocamlrun dynamic linking.
docdir [Odig.Pkg]
docdir p is p's documentation directory.
docdir [Odig.Conf]
docdir c is c's package documentation directory.
docdir_href [Odig.Conf]
docdir_href c is, for HTML generation, the base URI under which Odig.Conf.docdir is accessible expressed (if) relative to the root package list.
dt [Odig.Private.Html]

E
edge [Odig.Private.Dot]
edge ~atts id id' is an edge from id to id' with attribute atts if specified.
el [Odig.Private.Html]
el e ~atts c is an element e with attribute atts and content c.
el [Odig.Private.Json]
el v is v as a JSON array element.
el_if [Odig.Private.Json]
el_if c v is el (v ()) if c is true and Odig.Private.Json.empty otherwise.
empty [Odig.Private.Dot]
An empty sequence.
empty [Odig.Private.Html]
An empty sequence.
empty [Odig.Private.Json]
An empty sequence.
empty [Odig.Cobj.Index]
empty is an empty index.
empty_set [Odig.Cobj]
empty_set is an empty set of compilation objects.
equal [Odig.Pkg]
equal p p' is true if p and p' have the same name.

F
field [Odig.Pkg]
field ~err field f is v if field p = Ok v and err otherwise.
file [Odig.Private.Digest]
file f is the digest of file f.
find [Odig.Pkg]
find c n tries to find a package named n in c.
find_set [Odig.Pkg]
find_set c ns is (pkgs, not_found) where pkgs are the elements of ns which could be matched to a package in configuration c and not_found are those that could not be found or are not package names.
fold_rec_dep_resolutions [Odig.Cobj]
fold_rec_dep_resolutions ~deps f res acc folds f with acc over the partial evaluation order of res using deps on resolved objects.

G
graph [Odig.Private.Dot]
graph ~id ~strict g sts is according to g a graph or digraph id (default unlabelled) with statements sts.

H
h1 [Odig.Private.Html]
h2 [Odig.Private.Html]
help [Odig]
help () shows help about odig's toplevel support.
homepage [Odig.Pkg]
version p is p's homepage: field.
href [Odig.Private.Html]
href l is an href attribute with value l.
html [Odig.Private.Html]
html [Odig.Ocamldoc]
html ~ocamldoc ~force generates the html files from the .ocodoc files files of package p.
html [Odig.Odoc]
html ~odoc ~force p generates the html files from the .odoc files of package p.
htmldir [Odig.Ocamldoc]
htmldir c is is a function that returns the root or package ocamldoc HTML directory for c.
htmldir [Odig.Odoc]
htmldir c is is a function that returns the root or package odoc HTML directory for c.
htmldir_css_and_index [Odig.Ocamldoc]
htmldir_css_and_index c generates the ocamldoc css and html package index for configuration c.
htmldir_css_and_index [Odig.Odoc]
htmldir_css_and_index c generates the odoc css and html package index for configuration c.

I
id [Odig.Private.Html]
id i is an id attribute with value i.
init [Odig.Private.Top]
init ~conf () initalizes the toplevel support library with conf (defaults to Odig.Conf.default_file).
install_trail [Odig.Private.Pkg]
install_trail p is p's install trail.
int [Odig.Private.Json]
int i is i as a JSON number.
is_name [Odig.Pkg]
is_name n is true iff n is a valid package name.
issues [Odig.Pkg]
issues p is p's bug-report: field.

L
label [Odig.Private.Dot]
label l is label attribute l.
li [Odig.Private.Html]
libdir [Odig.Pkg]
libdir p is p's library directory (has the compilation objects).
libdir [Odig.Conf]
libdir c is c's package library directory.
license_tags [Odig.Pkg]
license_tags p is p's license: field.
licenses [Odig.Pkg]
licences p are the license files of p.
link [Odig.Private.Html]
load [Odig]
load ~force ~deps ~init ~dir "Mod" loads and setups include directories for the module Mod found in dir or in any package.
load_libs [Odig]
load_libs ~force ~deps ~init ~dir () loads and setups include directories for libraries found in dir.
load_ml [Odig.Private.Ocamltop]
load_ml ml loads the source ml file.
load_obj [Odig.Private.Ocamltop]
load_obj obj loads the cma or cmo file obj.
load_pkg [Odig]
load_pkg ~force ~deps ~init name loads all the libraries of the package named name.
lookup [Odig.Pkg]
lookup c n is the package named n in c.

M
maintainers [Odig.Pkg]
maintainers p is p's maintainer: field.
mem [Odig.Private.Json]
mem n v is an object member whose name is n and value is v.
mem_if [Odig.Private.Json]
mem_if c n v is mem n v if c is true and Odig.Private.Json.empty otherwise.
meta [Odig.Private.Html]
mlis [Odig.Cobj]
mlis s is the list of mlis contained in s.
mls [Odig.Cobj]
mls s is the list of mls contained in s.
mtimes [Odig.Private.Digest]
mtimes ps is a digest of the mtimes of ps.

N
name [Odig.Pkg]
name p is p's name.
name [Odig.Cobj.Cmxs]
name cmxs is cmxs's basename.
name [Odig.Cobj.Cmxa]
name cmxa is cmxa's basename.
name [Odig.Cobj.Cmx]
name cmx is the name of the module implementation.
name [Odig.Cobj.Cma]
name cma is cma's basename.
name [Odig.Cobj.Cmt]
name cmt is the name of the module interface.
name [Odig.Cobj.Cmo]
name cmo is the name of the module implementation.
name [Odig.Cobj.Ml]
name ml is the name of the module interface.
name [Odig.Cobj.Cmti]
name cmti is the name of the module interface.
name [Odig.Cobj.Cmi]
name cmi is the name of the module interface.
name [Odig.Cobj.Mli]
name mli is the name of the module interface.
name_of_string [Odig.Pkg]
name_of_string s is Ok s if is_name s is true and an error message otherwise
names [Odig.Cobj.Cmxa]
names ~init cmxa adds to init (defaults to String.Map.empty) the module names defined by cmxa mapped to their cmi digests.
names [Odig.Cobj.Cma]
names ~init cma adds to init (defaults to String.Map.empty) the module names defined by cma mapped to their cmi digests.
nav [Odig.Private.Html]
node [Odig.Private.Dot]
nod ~atts id is a node with id id and attributes atts if specified.
null [Odig.Private.Json]
null is the JSON null value.

O
obj [Odig.Private.Json]
obj mems is an object whose members are mems.
of_file [Odig.Conf]
of_file f reads a configuration from configuration file f.
of_opam_switch [Odig.Conf]
of_opam_switch ~switch () is a configuration for the opam switch switch (defaults to the current switch).
of_set [Odig.Cobj.Index]
of_set ~init t s is an index from s whose objects are tagged with t.
ol [Odig.Private.Html]
on_iter_error_msg [Odig.Private.Log]
online_doc [Odig.Pkg]
online_doc p is p's doc: field.
opam_fields [Odig.Pkg]
opam_fields p is the package's OPAM fields.
opam_file [Odig.Pkg]
opam_file p is p's expected OPAM file path.
output [Odig.Private.Dot]
output oc g outputs the dot graph g on oc.
output [Odig.Private.Html]
output is like Odig.Private.Html.buffer_add but outputs directly on a channel.
output [Odig.Private.Json]
output oc j outputs the JSON value j on oc.

P
p [Odig.Private.Html]
path [Odig.Cobj.Cmxs]
path cmxs is the file path to the cmxs file.
path [Odig.Cobj.Cmxa]
path cmxa is the file path to the cmxa file.
path [Odig.Cobj.Cmx]
path cmx is the file path to the cmx file.
path [Odig.Cobj.Cma]
path cma is the file path to the cma file.
path [Odig.Cobj.Cmt]
path cm is the file path to the cmt file.
path [Odig.Cobj.Cmo]
path cmo is the file path to the cmo file.
path [Odig.Cobj.Ml]
path ml is the file path to the ml file.
path [Odig.Cobj.Cmti]
path cmti is the file path to the cmti file.
path [Odig.Cobj.Cmi]
path cmi is the file path to the cmi file.
path [Odig.Cobj.Mli]
path mli is the file path to the mli file.
pkg_cachedir [Odig.Conf]
pkg_cachedir c is c's cache directory for packages it is located inside Odig.Conf.cachedir.
pp [Odig.Cobj.Digest]
pp ppf d prints the digest d as an hexadecimal string.
pp_dot [Odig.Private.Trail]
pp_dot_universe [Odig.Private.Trail]
pp_opt [Odig.Cobj.Digest]
pp_opt ppf od prints the optional digest od either like Odig.Cobj.Digest.pp or, for None as dashes.
pp_rec_dep_resolution [Odig.Cobj]
pp_rec_dep_resolution pp_obj is an unspecified formatter for recursive dependency resolutions using pp_obj to format objects.

Q
query [Odig.Cobj.Index]
query i q is (cmis, cmtis, cmos, cmxs, cmt) the compilations objects matching query q in i: cmis are those whose Odig.Cobj.Cmi.name or Odig.Cobj.Cmi.digest match., cmtis are those whose Odig.Cobj.Cmti.name or Odig.Cobj.Cmti.digest match., cmos are those whose Odig.Cobj.Cmo.name or Odig.Cobj.Cmo.cmi_digest match., cmxs are those whose Odig.Cobj.Cmx.name or Odig.Cobj.Cmx.digest or Odig.Cobj.Cmx.cmi_digest match., cmts are those whose Odig.Cobj.Cmt.name or Odig.Cobj.Cmt.cmi_digest match.
query_of_dep [Odig.Cobj.Index]
query_of_dep dep is the most precise query for dep.

R
read [Odig.Cobj.Cmxs]
read f reads a cmxs file from f.
read [Odig.Cobj.Cmxa]
read f reads a cmxa file from f.
read [Odig.Cobj.Cmx]
read f reads a cmx file from f.
read [Odig.Cobj.Cma]
read f reads a cma file from f.
read [Odig.Cobj.Cmt]
read f reads a cmt file from f.
read [Odig.Cobj.Cmo]
read f reads a cmo file from f.
read [Odig.Cobj.Ml]
read f reads an ml file from f.
read [Odig.Cobj.Cmti]
read f reads a cmti file from f.
read [Odig.Cobj.Cmi]
read f reads a cmi file from f.
read [Odig.Cobj.Mli]
read f reads an mli file from f.
readmes [Odig.Pkg]
readmes p are the readme files of p.
rec_cmis_for_interfaces [Odig.Cobj]
See, mutatis mutandis, Odig.Cobj.rec_cmos_for_interfaces.
rec_cmos_for_interfaces [Odig.Cobj]
rec_cmos_for_interfaces ~resolve i deps maps module names to the result of recursively resolving module interface dependencies deps (tupled with a dependency source) to cmos in i using resolve.
refresh_cache [Odig.Pkg]
refresh_cache p ensures p's cache status becomes `Fresh.
rem_inc [Odig.Private.Ocamltop]
rem_inc dir remove dir from the include path.
repo [Odig.Pkg]
repo p is p's dev-repo: field.
reset [Odig]
reset removes odig included directories and pretend all odig loaded libraries were not.

S
set [Odig.Pkg]
set c is the set of all packages in configuration c.
set_of_dir [Odig.Cobj]
set_of_dir ~err d is the set of compilation objects that are present in the file hierarchy rooted at d.
span [Odig.Private.Html]
src [Odig.Private.Log]
src is Odig's logging source.
status [Odig]
status outputs information about Odig's toplevel loads.
str [Odig.Private.Json]
str s is s as a JSON string value.
subgraph [Odig.Private.Dot]
subgraph ~id sts is subgraph id (default unlabelled) with statements sts.

T
tags [Odig.Pkg]
tags p is p's tags: field.
time [Odig.Private.Log]
to_cmi_dep [Odig.Cobj.Cmx]
to_cmi_dep cmx is cmx as a cmi dependency.
to_cmi_dep [Odig.Cobj.Cmo]
to_cmi_dep cmo is cmo as a cmi dependency.
to_cmi_dep [Odig.Cobj.Cmti]
to_cmi_dep cmti is cmti as a dependency.
to_cmi_dep [Odig.Cobj.Cmi]
to_cmi_dep cmi is cmi as a dependency.
to_cmi_deps [Odig.Cobj.Cmxa]
to_cmi_deps ~init cmxa adds to init (default to []) the module names and cmi digests of the modules defined by cmxa.
to_cmi_deps [Odig.Cobj.Cma]
to_cmi_deps ~init cma adds to init (default to []) the module names and cmi digests of the modules defined by cma.
to_string [Odig.Private.Dot]
to_string g is the dot graph g as a string.
to_string [Odig.Private.Html]
to_string is like Odig.Private.Html.buffer_add but returns directly a string.
to_string [Odig.Private.Json]
to_string j is the JSON value j as a string.
trust_cache [Odig.Conf]
trust_cache c indicates if c is trusting odig's cache.

U
ul [Odig.Private.Html]

V
v [Odig.Conf]
v ~trust_cache ~cachedir ~libdir ~docdir ~docdir_href () is a configuration using cachedir as the odig cache directory, libdir for looking up package compilation objects, docdir for looking up package documentation and docdir_href for specifying the location of docdir in generated html.
version [Odig.Pkg]
version p is p's version: field.

W
with_conf [Odig.Conf]
of_conf ~trust_cache ~docdir_href c is c updated with arguments specified, unspecfied ones are left untouched.