package opam-client

  1. Overview
  2. Docs
Client library for opam 2.0

Install 

dune-project
 Dependency

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

Authors

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

Maintainers

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

Sources

2.0.9.tar.gz
md5=abb7d7788f290d81d73b924b307b4bef
sha512=0d8ee19ac0f3df9de4fd9cfa8daab1f7228f090f5e2e7e26bedf24d8c2ab377aade95048f2d7cd9ee9dbbe738729e26dc99f41f730fa2252df74953362464a22

doc/opam-client/OpamAction/index.html

Module OpamActionSource

Handles concrete actions on packages, like installations and removals

Sourceval download_package : OpamStateTypes.rw OpamStateTypes.switch_state -> OpamTypes.package -> (string option * string) option OpamProcess.job

download t pkg downloads the source of the package pkg into its locally cached source dir. Returns Some (short_errmsg option, long_errmsg) on error, None on success. See OpamTypes.Not_available.

This doesn't update dev packages that already have a locally cached source.

Sourceval prepare_package_source : OpamStateTypes.rw OpamStateTypes.switch_state -> OpamTypes.package -> OpamTypes.dirname -> exn option OpamProcess.job

prepare_package_source t pkg dir updates the given source dir with the extra downloads, overlays and patches from the package's metadata applied.

Sourceval build_package : OpamStateTypes.rw OpamStateTypes.switch_state -> ?test:bool -> ?doc:bool -> OpamTypes.dirname -> OpamTypes.package -> exn option OpamProcess.job

build_package t build_dir pkg builds the package pkg within build_dir. Returns None on success, Some exn on error. See download_package and prepare_package_source for the previous steps.

Sourceval install_package : OpamStateTypes.rw OpamStateTypes.switch_state -> ?test:bool -> ?doc:bool -> ?build_dir:OpamTypes.dirname -> OpamTypes.package -> exn option OpamProcess.job

install_package t pkg installs an already built package. Returns None on success, Some exn on error. Do not update OPAM's metadata. See build_package to build the package.

Sourceval removal_needs_download : 'a OpamStateTypes.switch_state -> OpamTypes.package -> bool

Find out if the package source is needed for uninstall

Sourceval remove_package : OpamStateTypes.rw OpamStateTypes.switch_state -> ?silent:bool -> ?changes:OpamDirTrack.t -> ?force:bool -> ?build_dir:OpamTypes.dirname -> OpamTypes.package -> unit OpamProcess.job

Removes a package. If changes is unspecified, it is read from the package's change file. if force is specified, remove files marked as added in changes even if the files have been modified since.

Sourceval noop_remove_package : OpamStateTypes.rw OpamStateTypes.switch_state -> OpamTypes.package -> bool

Returns true whenever remove_package is a no-op.

Sourceval cleanup_package_artefacts : OpamStateTypes.rw OpamStateTypes.switch_state -> OpamTypes.package -> unit

Removes auxiliary files related to a package, after checking that they're not needed

Sourceval sources_needed : 'a OpamStateTypes.switch_state -> OpamSolver.ActionGraph.t -> OpamTypes.package_set

Compute the set of packages which will need to be downloaded to apply a solution. Takes a graph of atomic actions.