package opam-repository

  1. Overview
  2. Docs
Repository library for opam 2.4

Install 

dune-project
 Dependency

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

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.4.0-alpha2.tar.gz
md5=0fb8e9f62683772592b1bc2d80a763b8
sha512=1c617b1c1656817a47ef65d02fc990357476f6c1b406c02717e5ff702a2c42e9f3818c2ddd54470926b2c5344c1c285216471a684d261be7a3ec84b05a32e726

doc/opam-repository/OpamGit/VCS/index.html

Module OpamGit.VCSSource

Sourceval exists : OpamTypes.dirname -> bool

Test whether the given repository is correctly initialized.

Init a repository.

Sourceval fetch : ?full_fetch:bool -> ?cache_dir:OpamTypes.dirname -> ?subpath:OpamTypes.subpath -> OpamTypes.dirname -> OpamTypes.url -> unit OpamProcess.job

Fetch changes from upstream. This is supposed to put the changes in a staging area. Be aware that the remote URL might have been changed, so make sure to update accordingly.

If full_fetch is set to false, VCS repository is retrieved with shallow history (by default, full history). If cache_dir is given, the directory is used by VCS tool as a its cache directory. If subpath is given, only that subpath of the url is retrieved.

Reset the master branch of the repository to match the remote repository state. This might still fetch more data (git submodules...), so is unsuitable for running after validation.

Confirm that applying the patch results in a clean synchronization of the working tree with its repository state.

Returns the pending modifications in the form of a patch file, or None if dirname is up to date with what was last fetched.

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

Returns true if the last fetched state is equal to the current, on-disk state

Sourceval revision : OpamTypes.dirname -> string option OpamProcess.job

Returns an backend-specific identifier for the current revision.

Sourceval versioned_files : OpamTypes.dirname -> string list OpamProcess.job

Returns the list of files under version control

Returns the absolute directory name for vc data (e.g. .../project/.git)

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

Returns the currently selected branch handle. It should be valid as the hash field of OpamUrl.t.

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

Returns true if the working tree state is different from the state recorded in the VCS as current. This differs from is_up_to_date, which compares specifically to the last fetched state. This should always be false after reset has been called.

Sourceval modified_files : OpamTypes.dirname -> string list OpamProcess.job

Returns the list of files under version control, modified in the working tree but not committed

Sourceval get_remote_url : ?hash:string -> OpamTypes.dirname -> OpamTypes.url option OpamProcess.job