package opam-client

  1. Overview
  2. Docs

Functions handling the "opam repository" subcommand

val list : 'a OpamStateTypes.repos_state -> global:bool -> switches:OpamTypes.switch list -> short:bool -> unit

List the selected repositories in the global default and/or selected switches.

val list_all : 'a OpamStateTypes.repos_state -> short:bool -> unit

Lists all configured repositories, and, if not short, the switches they are selected in.

val add : OpamStateTypes.rw OpamStateTypes.repos_state -> OpamTypes.repository_name -> OpamTypes.url -> OpamTypes.trust_anchors option -> OpamStateTypes.rw OpamStateTypes.repos_state

Add a new repository to ~/.opam/repos, without updating any selections

val remove : OpamStateTypes.rw OpamStateTypes.repos_state -> OpamTypes.repository_name -> OpamStateTypes.rw OpamStateTypes.repos_state

Remove a repository from ~/.opam/repos, without updating any selections

val update_global_selection : OpamStateTypes.rw OpamStateTypes.global_state -> (OpamTypes.repository_name list -> OpamTypes.repository_name list) -> OpamStateTypes.rw OpamStateTypes.global_state

Updates the global switch selection, used as default for switches that don't specify their selections (e.g. newly created switches)

val update_selection : 'a OpamStateTypes.global_state -> global:bool -> switches:OpamTypes.switch list -> (OpamTypes.repository_name list -> OpamTypes.repository_name list) -> 'a OpamStateTypes.global_state

Updates the specified selections using the given functions, taking locks as required

val set_url : OpamStateTypes.rw OpamStateTypes.repos_state -> OpamTypes.repository_name -> OpamTypes.url -> OpamTypes.trust_anchors option -> OpamStateTypes.rw OpamStateTypes.repos_state

Change the registered address of a repo

val update_with_auto_upgrade : OpamStateTypes.rw OpamStateTypes.repos_state -> OpamTypes.repository_name list -> OpamTypes.repository_name list * OpamStateTypes.rw OpamStateTypes.repos_state

Update the given repositories, as per OpamUpdate.repositories, checks for their version and runs the upgrade script locally if they are for an earlier opam. Returns true if no update or upgrade errors were encountered.

OCaml

Innovation. Community. Security.