package opam-format

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Configuration files
Repository files

package opam-format

opam-format
- Library opam-format
  - OpamFile
    
    IO_FILE
    
    BestEffortRead
    
    Lines
    
    Wrappers
    
    Config
    
    BestEffort
    
    InitConfig
    
    Descr
    
    URL
    
    OPAM
    
    Aliases
    
    LegacyState
    
    SwitchSelections
    
    BestEffort
    
    SwitchExport
    
    PkgList
    
    Environment
    
    Comp
    
    Dot_install
    
    Changes
    
    Dot_config
    
    Package_index
    
    Repo_config_legacy
    
    Repos_config
    
    BestEffort
    
    Switch_config
    
    BestEffort
    
    Pinned_legacy
    
    Repo
    
    File_attributes
    
    Stats
    
    Syntax
  - OpamFilter
  - OpamFormat
    
    V
    
    I
  - OpamFormatConfig
    
    E
  - OpamFormula
  - OpamInterpLexer
  - OpamLineLexer
  - OpamPackage
    
    Version
    
    Set
    
    Op
    
    Map
    
    Name
    
    Set
    
    Op
    
    Map
    
    Set
    
    Op
    
    Map
    
    Graph
    
    V
    
    E
    
    Topological
    
    Parallel
    
    G
    
    V
    
    E
    
    Vertex
    
    Topological
    
    Dot
  - OpamPath
    
    LAYOUT
    
    Switch
    
    Default
    
    DefaultF
    
    Overlay
    
    Builddir
  - OpamPp
    
    Op
    
    STR
  - OpamRepositoryName
    
    Set
    
    Op
    
    Map
  - OpamSwitch
    
    Set
    
    Op
    
    Map
  - OpamSysPkg
    
    Set
    
    Op
    
    Map
  - OpamTypes
    
    GenericPackage
  - OpamTypesBase
    
    String
    
    Char
    
    Either
    
    Printexc
    
    Unix
    
    Uchar
    
    Buffer
    
    Filename
    
    Result
    
    Lazy
  - OpamVariable
    
    Set
    
    Op
    
    Map
    
    Full
    
    Set
    
    Op
    
    Map
- Sources
  - opam-format
    
    opamFile.ml
    
    opamFilter.ml
    
    opamFormat.ml
    
    opamFormatConfig.ml
    
    opamFormula.ml
    
    opamInterpLexer.ml
    
    opamLineLexer.ml
    
    opamPackage.ml
    
    opamPath.ml
    
    opamPp.ml
    
    opamRepositoryName.ml
    
    opamSwitch.ml
    
    opamSysPkg.ml
    
    opamTypesBase.ml
    
    opamVariable.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `OpamFile`Source

Handles all OPAM file formats as record types and submodules, conversion to and from syntax

Functions to read and write OPAM configuration files in a typed way

Sourcetype 'a t = private OpamTypes.filename

Associate a type to a filename through a phantom type

Sourcetype 'a typed_file = 'a t

Sourceval make : OpamTypes.filename -> 'a t

Sourceval filename : 'a t -> OpamTypes.filename

Sourceval to_string : 'a t -> string

Sourceval exists : 'a t -> bool

Sourcemodule type IO_FILE = sig ... end

All Configuration files satisfy this signature

Sourcemodule type BestEffortRead = sig ... end

Sourcemodule Lines : IO_FILE with type t = string list list

Lines of space-separated words.

Sourcemodule Wrappers : sig ... end

Command wrappers for package scripts

Sourcemodule Config : sig ... end

Configuration file: $opam/config

Sourcemodule InitConfig : sig ... end

Init config file /etc/opamrc

Sourcemodule Descr : sig ... end

Package descriptions: $opam/descr/

Sourcemodule URL : sig ... end

Sourcemodule OPAM : sig ... end

OPAM files

Sourcemodule Aliases : IO_FILE with type t = string OpamTypes.switch_map

Compiler aliases: $opam/aliases. Deprecated, used only for migration

Sourcemodule LegacyState : sig ... end

Switch state file as table, also used for import/export. This includes compiler and root packages information, as well as pinned packages and their target (but not their local metadata).

Sourcemodule SwitchSelections : sig ... end

A newer format for switch state, using the opam file syntax rather than a table. This is more readable and extensible.

Sourcemodule SwitchExport : sig ... end

An extended version of SwitchSelections that can include full opam files as package "name" {} sections, for storing overlays

Sourcemodule PkgList : IO_FILE with type t = OpamTypes.package_set

A simple list of packages and versions: (used for the older $opam/$switch/{installed,installed_roots}, still needed to migrate from 1.2 repository, and for reinstall)

Sourcemodule Environment : IO_FILE with type t = OpamTypes.env_update list

Cached environment updates (<switch>/environment)

Sourcemodule Comp : sig ... end

Compiler version $opam/compilers/. Deprecated, only used to upgrade old data

Configuration files

Sourcemodule Dot_install : sig ... end

.install files

Sourcemodule Changes : sig ... end

.changes files, bound to the OpamDirTrack module

Sourcemodule Dot_config : sig ... end

.config files

Repository files

Source

module Package_index : 
  IO_FILE
    with type t =
           (OpamTypes.repository_name * string option) OpamTypes.package_map

Association between package names and repositories

Sourcemodule Repo_config_legacy : sig ... end

Repository config: $opam/repo/$repo/config. Deprecated, for migration only

Sourcemodule Repos_config : sig ... end

Sourcemodule Switch_config : sig ... end

Sourcemodule Pinned_legacy : sig ... end

Pinned package files (only used for migration from 1.2, the inclusive State module is now used instead)

Sourcemodule Repo : sig ... end

Repository metadata

Sourcemodule File_attributes : IO_FILE with type t = OpamTypes.file_attribute_set

Sourcemodule Stats : sig ... end

Sourcemodule Syntax : sig ... end

Helper module for manipulation of the raw syntax (opamfile) format. (the specific file handling modules are derived from this one)

package opam-format

Module OpamFileSource

Configuration files

Repository files

Module `OpamFile`Source