package opam-core

You can search for identifiers within the package.

in-package search v0.2.0

package opam-core

opam-core
- OpamCompat
- OpamConsole
- OpamCoreConfig
- OpamDirTrack
- OpamFilename
  - Attribute
    
    Map
    
    Set
    
    Op
  - Base
    
    Map
    
    Set
    
    Op
  - Dir
    
    Map
    
    Set
    
    Op
  - Map
  - Op
  - Set
    
    Op
- OpamHash
  - Map
  - Set
    
    Op
- OpamJson
- OpamParallel
  - G
    
    E
    
    Topological
    
    V
    
    Vertex
  - GRAPH
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
    
    Topological
    
    V
  - Make
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
  - MakeGraph
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
    
    Topological
    
    V
  - SIG
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
  - VERTEX
- OpamProcess
  - Job
    
    Op
- OpamSHA
- OpamStd
  - ABSTRACT
    
    Map
    
    Set
    
    Op
  - AbstractString
    
    Map
    
    Set
    
    Op
  - Config
    
    Sig
  - Env
  - Exn
  - Format
  - IntMap
  - IntSet
    
    Op
  - List
  - MAP
  - Map
    
    Make
    
    S
  - Op
  - Option
    
    Op
  - OrderedType
  - SET
    
    Op
  - Set
    
    Make
    
    Op
    
    S
  - String
    
    Map
    
    Set
    
    Op
    
    SetMap
    
    SetSet
    
    Op
  - Sys
- OpamSystem
- OpamUrl
  - Map
  - Op
  - Set
    
    Op
- OpamVersion
  - Map
  - Set
    
    Op
- OpamVersionCompare

Legend:
Library
Module
Module type
Parameter
Class
Class type

type digest

uniquely identifies a filesystem item value

type change =

| Added of digest
| Removed
| Contents_changed of digest
(*
For links, corresponds to a change of target
*)
| Perm_changed of digest
| Kind_changed of digest
(*
Used e.g. when a file is replaced by a directory, a link or a fifo
*)

Defines a change concerning a fs item; The digest parameter is the new value of the item

type t = change OpamStd.String.Map.t

val to_string : t -> string

Returns a printable, multi-line string

val digest_of_string : string -> digest

val string_of_digest : digest -> string

val track : 
  OpamFilename.Dir.t ->
  ?except:OpamFilename.Base.Set.t ->
  (unit -> 'a OpamProcess.job) ->
  ('a * t) OpamProcess.job

Wraps a job to track the changes that happened under dirname during its execution (changes done by the application of the job function to () are tracked too, for consistency with jobs without commands)

val revert : 
  ?title:string ->
  ?verbose:bool ->
  ?force:bool ->
  OpamFilename.Dir.t ->
  t ->
  unit

Removes the added and kind-changed items unless their contents changed and force isn't set, and prints warnings for other changes unless verbose is set to false. Ignores non-existing files. title is used to prefix messages if specified.

val check : 
  OpamFilename.Dir.t ->
  t ->
  (OpamFilename.t * [ `Unchanged | `Removed | `Changed ]) list

Checks the items that were added or kind-changed in the given diff, and returns their status