package opam-client

You can search for identifiers within the package.

in-package search v0.2.0

opam-client

Legend:
Library
Module
Module type
Parameter
Class
Class type

Functions handling the "opam pin" subcommand

val version_pin : 
  OpamStateTypes.rw OpamStateTypes.switch_state ->
  OpamTypes.name ->
  OpamTypes.version ->
  OpamStateTypes.rw OpamStateTypes.switch_state

Pins a package to the given version, and writes to disk. Returns the updated state. The main difference with source_pin is that a definition overlay is not created. Therefore, the package must exist already.

val source_pin : 
  OpamStateTypes.rw OpamStateTypes.switch_state ->
  OpamTypes.name ->
  ?version:OpamTypes.version ->
  ?edit:bool ->
  ?force:bool ->
  OpamTypes.url option ->
  OpamStateTypes.rw OpamStateTypes.switch_state

Sets the package as pinned to the given target. A package definition is looked for in the package source and current metadata (in this order).

If edit, or if no package definition is found, this opens an editor (with a template if no definition is available).

If force, don't abort even if the source can't be fetched from target

val edit : 
  OpamStateTypes.rw OpamStateTypes.switch_state ->
  ?version:OpamTypes.version ->
  OpamTypes.name ->
  OpamStateTypes.rw OpamStateTypes.switch_state

Let the user edit a pinned package's opam file. If given, the version is put into the template in advance. Writes and returns the updated switch state.

val unpin : 
  OpamStateTypes.rw OpamStateTypes.switch_state ->
  OpamTypes.name list ->
  OpamStateTypes.rw OpamStateTypes.switch_state

Unpin packages

val list : 'a OpamStateTypes.switch_state -> short:bool -> unit

List the pinned packages to the user.