package opam-repository

  1. Overview
  2. Docs
Repository library for opam 2.2

Install 

dune-project
 Dependency

opam.ocaml.org Readme Edit opam file Versions (30)

Authors

  1. David Allsopp
  2. V
    Vincent Bernardoff <vb@luminar.eu.org>
  3. R
    Raja Boujbel <raja.boujbel@ocamlpro.com>
  4. K
    Kate Deplaix <kit-ty-kate@outlook.com>
  5. R
    Roberto Di Cosmo <roberto@dicosmo.org>
  6. T
    Thomas Gazagnaire <thomas@gazagnaire.org>
  7. L
    Louis Gesbert <louis.gesbert@ocamlpro.com>
  8. F
    Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
  9. A
    Anil Madhavapeddy <anil@recoil.org>
  10. G
    Guillem Rieu <guillem.rieu@ocamlpro.com>
  11. R
    Ralf Treinen <ralf.treinen@pps.jussieu.fr>
  12. F
    Frederic Tuong <tuong@users.gforge.inria.fr>

Maintainers

  1. O
    opam-devel@lists.ocaml.org

Sources

2.2.0.tar.gz
md5=e9a76b200b58d303507317e8d28f2a6d
sha512=410c662d6dbd289433c61ff36a8591c3df2f2dc1d0fd48bf69fbec9cf57ebc33fbe05e02096e26c91f7ff1485c00d77e7fddcd63e4c1f2293136312f5ddfbe05

doc/opam-repository/OpamRepository/index.html

Module OpamRepositorySource

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

Get the list of packages

Sourceval packages_with_prefixes : OpamTypes.dirname -> string option OpamTypes.package_map

Get the list of packages (and their possible prefix)

Repository backends

Sourceval update : OpamTypes.repository -> OpamTypes.dirname -> [ `Changes | `No_changes ] OpamProcess.job

Update $opam/repo/$repo. Raises Failure in case the update couldn't be achieved. Returns `No_changes if the update did not bring any changes, and `Changes otherwise.

Sourceval pull_shared_tree : ?cache_dir:OpamTypes.dirname -> ?cache_urls:OpamUrl.t list -> (string * OpamFilename.Dir.t * OpamTypes.subpath option) list -> OpamHash.t list -> OpamTypes.url list -> string OpamTypes.download OpamProcess.job

pull_shared_tree ?cache_dir ?cache_url labels_dirnames checksums urls Fetch an URL and put the resulting tree into the supplied directories specified in labels_dirnames. The string in labels_dirnames are text labels of this given dirname for display. urls must either point to a tree (VCS, rsync) or to a known archive type. In case of an archive, the cache_dir is used and supplied the hashes verified, then the archive uncompressed. In case of a version-controlled URL, it's checked out, or synchronised directly if local and working_dir was set. cache_urls is used to retrieve from repository caches.

Sourceval pull_tree : string -> ?full_fetch:bool -> ?cache_dir:OpamTypes.dirname -> ?cache_urls:OpamTypes.url list -> ?working_dir:bool -> ?subpath:OpamTypes.subpath -> OpamTypes.dirname -> OpamHash.t list -> OpamTypes.url list -> string OpamTypes.download OpamProcess.job
Sourceval pull_file : string -> ?cache_dir:OpamTypes.dirname -> ?cache_urls:OpamTypes.url list -> ?silent_hits:bool -> OpamTypes.filename -> OpamHash.t list -> OpamTypes.url list -> unit OpamTypes.download OpamProcess.job

Same as pull_tree, but for fetching a single file.

Sourceval pull_file_to_cache : string -> cache_dir:OpamTypes.dirname -> ?cache_urls:OpamTypes.url list -> OpamHash.t list -> OpamTypes.url list -> string OpamTypes.download OpamProcess.job

Same as pull_file, but without a destination file: just ensures the file is present in the cache.

The file where the file with the given hash is stored under cache at given dirname.

Get the optional revision associated to a backend (git hash, etc.).

Sourceval current_branch : OpamTypes.url -> string option OpamProcess.job

Get the version-control branch for that url. Only applicable for local, version controlled URLs. Returns None in other cases.

Sourceval is_dirty : ?subpath:OpamTypes.subpath -> OpamTypes.url -> bool OpamProcess.job

Returns true if the url points to a local, version-controlled directory that has uncommitted changes

Find a backend

Sourceval find_backend_by_kind : OpamUrl.backend -> (module OpamRepositoryBackend.S)
Sourceval report_fetch_result : OpamTypes.package -> string OpamTypes.download -> unit OpamTypes.download

Prints user messages upon the result of a download