package opam-repository

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Repository backends

opam-repository
- OpamDarcs
  - B
- OpamDownload
- OpamGit
  - B
- OpamHTTP
  - B
- OpamHg
  - B
- OpamLocal
  - B
- OpamRepository
- OpamRepositoryBackend
  - S
- OpamRepositoryConfig
- OpamRepositoryPath
  - Remote
- OpamVCS
  - Make
    
    VCS
  - VCS

Legend:
Library
Module
Module type
Parameter
Class
Class type

Operations on repositories (update, fetch...) based on the different backends implemented in separate modules

val packages : OpamTypes.repository -> OpamTypes.package_set

Get the list of packages

val packages_with_prefixes : 
  OpamTypes.repository ->
  string option OpamTypes.package_map

Get the list of packages (and their possible prefix)

Repository backends

val init : 
  OpamTypes.dirname ->
  OpamTypes.repository_name ->
  unit OpamProcess.job

Initialize $opam/repo/$repo

val update : OpamTypes.repository -> unit OpamProcess.job

Update $opam/repo/$repo.

val pull_url : 
  OpamTypes.package ->
  OpamTypes.dirname ->
  OpamHash.t option ->
  OpamTypes.url list ->
  OpamTypes.generic_file OpamTypes.download OpamProcess.job

Download an url. Several mirrors can be provided, in which case they will be tried in order in case of an error.

val pull_url_and_fix_digest : 
  OpamTypes.package ->
  OpamTypes.dirname ->
  OpamHash.t ->
  OpamFile.URL.t OpamFile.t ->
  OpamTypes.url list ->
  OpamTypes.generic_file OpamTypes.download OpamProcess.job

Pull and fix the resulting digest

val pull_archive : 
  OpamTypes.repository ->
  OpamTypes.package ->
  OpamTypes.filename OpamTypes.download OpamProcess.job

Pull an archive in a repository

val revision : OpamTypes.repository -> OpamTypes.version option OpamProcess.job

Get the optional revision associated to a backend.

val make_archive : 
  ?gener_digest:bool ->
  OpamTypes.repository ->
  string option ->
  OpamTypes.package ->
  unit OpamProcess.job

make_archive ?gener_digest repo prefix package builds the archive for the given package. By default, the digest that appears in $NAME.$VERSION/url is not modified, unless gener_digest is set.

val find_backend : OpamTypes.repository -> (module OpamRepositoryBackend.S)

Find a backend

val find_backend_by_kind : OpamUrl.backend -> (module OpamRepositoryBackend.S)