package opam-format

You can search for identifiers within the package.

in-package search v0.2.0

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 `OpamPath.Switch`Source

Switch related paths

Locations of opam internal dirs and files

Sourceval root : t -> OpamTypes.switch -> OpamTypes.dirname

The switch prefix: $opam/$switch

Sourceval meta_dirname : string

The name of the subdir of the switch prefix where opam data is stored (".opam-switch")

Sourceval meta : t -> OpamTypes.switch -> OpamTypes.dirname

The subdirectory of the prefix where opam data lives: $opam/$switch/.opam-switch

Sourceval lock : t -> OpamTypes.switch -> OpamTypes.filename

lock file: $meta/lock

Sourceval backup_dir : t -> OpamTypes.switch -> OpamTypes.dirname

The directory where backups are stored for this switch

Sourceval backup : t -> OpamTypes.switch -> OpamTypes.switch_selections OpamFile.t

Backup file for state export

Source

val selections : 
  t ->
  OpamTypes.switch ->
  OpamTypes.switch_selections OpamFile.t

Switch selections $meta/switch-state

Sourceval build : t -> OpamTypes.switch -> OpamTypes.package -> OpamTypes.dirname

Temporary folders used to decompress and compile the corresponding archives: $meta/build/$packages

Sourceval remove : t -> OpamTypes.switch -> OpamTypes.package -> OpamTypes.dirname

Temporary folders used to decompress the corresponding archives, used only for package removal $meta/remove/$packages

Sourceval build_dir : t -> OpamTypes.switch -> OpamTypes.dirname

Temporary folder: $meta/build

Sourceval remove_dir : t -> OpamTypes.switch -> OpamTypes.dirname

Temporary folder: $meta/remove

Source

val install : 
  t ->
  OpamTypes.switch ->
  OpamTypes.name ->
  OpamFile.Dot_install.t OpamFile.t

Installed files for a given package: $meta/install/$name.install

Source

val changes : 
  t ->
  OpamTypes.switch ->
  OpamTypes.name ->
  OpamDirTrack.t OpamFile.t

File registering the changes made by the installation of the given package $meta/install/$name.changes

Sourceval install_dir : t -> OpamTypes.switch -> OpamTypes.dirname

Installed files: $meta/install/

Sourceval reinstall : t -> OpamTypes.switch -> OpamFile.PkgList.t OpamFile.t

Packages to reinstall on next upgrade: $meta/reinstall

Sourceval config_dir : t -> OpamTypes.switch -> OpamTypes.dirname

Configuration folder: $meta/config

Source

val switch_config : 
  t ->
  OpamTypes.switch ->
  OpamFile.Switch_config.t OpamFile.t

Global config for the switch: $meta/switch-config

Source

val config : 
  t ->
  OpamTypes.switch ->
  OpamTypes.name ->
  OpamFile.Dot_config.t OpamFile.t

Package-specific configuration file for installed packages: $meta/config/$name.config

Sourceval sources_dir : t -> OpamTypes.switch -> OpamTypes.dirname

Clean, uncompressed sources for this switch: $meta/sources/

Sourceval sources : t -> OpamTypes.switch -> OpamTypes.package -> OpamTypes.dirname

Clean, uncompressed source directory for this package: $meta/sources/$name.$version/

Sourceval extra_files_dir : t -> OpamTypes.switch -> OpamTypes.dirname

Temporary switch-local directory where a by-hash map of extra files may be stored. This is used for switch-imports: $meta/extra-files-cache

Sourceval extra_file : t -> OpamTypes.switch -> OpamHash.t -> OpamTypes.filename

Extra file with the given hash from the temporary switch-import cache: $meta/extra-files-cache/HASH

Source

val pinned_package : 
  t ->
  OpamTypes.switch ->
  OpamTypes.name ->
  OpamTypes.dirname

Mirror of the sources for a given pinned package: $meta/sources/$name/ (without version)

Sourceval environment : t -> OpamTypes.switch -> OpamFile.Environment.t OpamFile.t

Cached environment updates.

Source

val env_relative_to_prefix : 
  OpamTypes.dirname ->
  OpamFile.Environment.t OpamFile.t

Like environment, but from the switch prefix dir

Sourceval installed_opams : t -> OpamTypes.switch -> OpamTypes.dirname

Directory where the metadata of installed packages is mirrored. $meta/packages/

Sourceval installed_opams_cache : t -> OpamTypes.switch -> OpamTypes.filename

Cache file for the mirrored installed package metadata $meta/packages/cache

Source

val installed_package_dir : 
  t ->
  OpamTypes.switch ->
  OpamTypes.package ->
  OpamTypes.dirname

The mirror of the package definition for the given installed package $meta/packages/$name.$version/

Source

val installed_opam : 
  t ->
  OpamTypes.switch ->
  OpamTypes.package ->
  OpamFile.OPAM.t OpamFile.t

The mirror of the opam file for the given installed package $meta/packages/$name.$version/opam

Source

val installed_opam_files_dir : 
  t ->
  OpamTypes.switch ->
  OpamTypes.package ->
  OpamTypes.dirname

Mirror of the extra files attached to the package definitions of installed packages $meta/packages/$name.$version/files/

Locations for the visible part of the installation

Sourcemodule Default : sig ... end

Default config

Sourcemodule DefaultF (L : LAYOUT) : sig ... end

Fuctorised version of Default, for replicating a switch's layout in non-switch contexts

Actual config handling the global-config.config indirections

Package-independent dirs

Source

val get_stdpath : 
  t ->
  OpamTypes.switch ->
  OpamFile.Switch_config.t ->
  OpamTypes.std_path ->
  OpamTypes.dirname

Source

val lib_dir : 
  t ->
  OpamTypes.switch ->
  OpamFile.Switch_config.t ->
  OpamTypes.dirname

Library path: $prefix/lib

Source

val stublibs : 
  t ->
  OpamTypes.switch ->
  OpamFile.Switch_config.t ->
  OpamTypes.dirname

DLL paths

Source

val toplevel : 
  t ->
  OpamTypes.switch ->
  OpamFile.Switch_config.t ->
  OpamTypes.dirname

toplevel path: $prefix/lib/toplevel

Source

val doc_dir : 
  t ->
  OpamTypes.switch ->
  OpamFile.Switch_config.t ->
  OpamTypes.dirname

Documentation path: $prefix/doc/

Source

val share_dir : 
  t ->
  OpamTypes.switch ->
  OpamFile.Switch_config.t ->
  OpamTypes.dirname

Shared directory: $prefix/share

Source

val etc_dir : 
  t ->
  OpamTypes.switch ->
  OpamFile.Switch_config.t ->
  OpamTypes.dirname

Etc directory: $prefix/etc

Source

val man_dir : 
  ?num:string ->
  t ->
  OpamTypes.switch ->
  OpamFile.Switch_config.t ->
  OpamTypes.dirname

Man pages path: $prefix/man/. The optional num argument will add a manN suffix if specified

Source

val bin : 
  t ->
  OpamTypes.switch ->
  OpamFile.Switch_config.t ->
  OpamTypes.dirname

Installed binaries: $prefix/bin

Source

val sbin : 
  t ->
  OpamTypes.switch ->
  OpamFile.Switch_config.t ->
  OpamTypes.dirname

Installed system binaries: $prefix/sbin

Package dependent dirs

Source

val lib : 
  t ->
  OpamTypes.switch ->
  OpamFile.Switch_config.t ->
  OpamTypes.name ->
  OpamTypes.dirname

Library path for a given package: $prefix/lib/$name

Source

val doc : 
  t ->
  OpamTypes.switch ->
  OpamFile.Switch_config.t ->
  OpamTypes.name ->
  OpamTypes.dirname

Documentation path for a given package: $prefix/doc/$name

Source

val share : 
  t ->
  OpamTypes.switch ->
  OpamFile.Switch_config.t ->
  OpamTypes.name ->
  OpamTypes.dirname

Share directory for a given package: $prefix/share/$package

Source

val etc : 
  t ->
  OpamTypes.switch ->
  OpamFile.Switch_config.t ->
  OpamTypes.name ->
  OpamTypes.dirname

Etc directory for a given package: $prefix/etc/$package

Sourcemodule Overlay : sig ... end

package opam-format

Module OpamPath.SwitchSource

Module `OpamPath.Switch`Source