forked from ocaml/opam
-
Notifications
You must be signed in to change notification settings - Fork 4
/
OpamRepository.html
104 lines (104 loc) · 7.83 KB
/
OpamRepository.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="OpamProcess.html">
<link rel="next" href="OpamSolver.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="OpamAlias" rel="Chapter" href="OpamAlias.html">
<link title="OpamClient" rel="Chapter" href="OpamClient.html">
<link title="OpamCompiler" rel="Chapter" href="OpamCompiler.html">
<link title="OpamFile" rel="Chapter" href="OpamFile.html">
<link title="OpamFilename" rel="Chapter" href="OpamFilename.html">
<link title="OpamFormat" rel="Chapter" href="OpamFormat.html">
<link title="OpamFormula" rel="Chapter" href="OpamFormula.html">
<link title="OpamMisc" rel="Chapter" href="OpamMisc.html">
<link title="OpamPackage" rel="Chapter" href="OpamPackage.html">
<link title="OpamParallel" rel="Chapter" href="OpamParallel.html">
<link title="OpamPath" rel="Chapter" href="OpamPath.html">
<link title="OpamProcess" rel="Chapter" href="OpamProcess.html">
<link title="OpamRepository" rel="Chapter" href="OpamRepository.html">
<link title="OpamSolver" rel="Chapter" href="OpamSolver.html">
<link title="OpamSystem" rel="Chapter" href="OpamSystem.html">
<link title="OpamTypes" rel="Chapter" href="OpamTypes.html">
<link title="OpamVariable" rel="Chapter" href="OpamVariable.html">
<link title="OpamVersion" rel="Chapter" href="OpamVersion.html"><link title="Repository backends" rel="Section" href="#2_Repositorybackends">
<title>OpamRepository</title>
</head>
<body>
<div class="navbar"><a href="OpamProcess.html">Previous</a>
<a href="index.html">Up</a>
<a href="OpamSolver.html">Next</a>
</div>
<center><h1>Module <a href="type_OpamRepository.html">OpamRepository</a></h1></center>
<br>
<pre><span class="keyword">module</span> OpamRepository: <code class="code">sig</code> <a href="OpamRepository.html">..</a> <code class="code">end</code></pre>Mangagement of OPAM repositories.<br>
<hr width="100%">
<pre><span id="EXCEPTIONUnknown_backend"><span class="keyword">exception</span> Unknown_backend</span></pre>
<pre><span class="keyword">include</span> <a href="OpamMisc.ABSTRACT.html">OpamMisc.ABSTRACT</a></pre>
<pre><span id="VALdefault"><span class="keyword">val</span> default</span> : <code class="type"><a href="OpamTypes.html#TYPErepository">OpamTypes.repository</a></code></pre><div class="info">
Default repository<br>
</div>
<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">name:string -> kind:string -> address:string -> <a href="OpamTypes.html#TYPErepository">OpamTypes.repository</a></code></pre><div class="info">
Constructor<br>
</div>
<pre><span id="VALlocal_repo"><span class="keyword">val</span> local_repo</span> : <code class="type">unit -> <a href="OpamPath.Repository.html#TYPEr">OpamPath.Repository.r</a></code></pre><div class="info">
Create a dummy local repository<br>
</div>
<pre><span id="VALremote_repo"><span class="keyword">val</span> remote_repo</span> : <code class="type"><a href="OpamTypes.html#TYPEdirname">OpamTypes.dirname</a> -> <a href="OpamPath.Repository.html#TYPEr">OpamPath.Repository.r</a></code></pre><div class="info">
Create a dummy remote repository<br>
</div>
<pre><span id="VALinit"><span class="keyword">val</span> init</span> : <code class="type"><a href="OpamTypes.html#TYPErepository">OpamTypes.repository</a> -> unit</code></pre><div class="info">
Initialize <i>$opam/repo/$repo</i><br>
</div>
<pre><span id="VALupdate"><span class="keyword">val</span> update</span> : <code class="type"><a href="OpamTypes.html#TYPErepository">OpamTypes.repository</a> -> unit</code></pre><div class="info">
Update <i>$opam/repo/$repo</i><br>
</div>
<pre><span id="VALdownload"><span class="keyword">val</span> download</span> : <code class="type"><a href="OpamTypes.html#TYPErepository">OpamTypes.repository</a> -> <a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> -> unit</code></pre><div class="info">
Download <i>$opam/repo/$repo/archive/$nv.tar.gz</i><br>
</div>
<pre><span id="VALupload"><span class="keyword">val</span> upload</span> : <code class="type"><a href="OpamTypes.html#TYPErepository">OpamTypes.repository</a> -> unit</code></pre><div class="info">
Upload the content of <i>$opam/repo/$repo/upload</i> to the remote
repository.<br>
</div>
<br>
<span id="2_Repositorybackends"><h2>Repository backends</h2></span><br>
<pre><span class="keyword">module type</span> <a href="OpamRepository.BACKEND.html">BACKEND</a> = <code class="code">sig</code> <a href="OpamRepository.BACKEND.html">..</a> <code class="code">end</code></pre><div class="info">
Backend signature
</div>
<pre><span id="VALregister_backend"><span class="keyword">val</span> register_backend</span> : <code class="type"><a href="OpamTypes.html#TYPEkind">OpamTypes.kind</a> -> (module OpamRepository.BACKEND) -> unit</code></pre><div class="info">
Register a repository backend<br>
</div>
<pre><span id="VALfind_backend"><span class="keyword">val</span> find_backend</span> : <code class="type"><a href="OpamTypes.html#TYPEkind">OpamTypes.kind</a> -> (module OpamRepository.BACKEND)</code></pre><div class="info">
Find a backend<br>
</div>
<pre><span id="VALcopy_files"><span class="keyword">val</span> copy_files</span> : <code class="type"><a href="OpamPath.Repository.html#TYPEr">OpamPath.Repository.r</a> -> <a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> -> OpamFilename.Set.t</code></pre><div class="info">
Copy the additional package files in the current dir<br>
</div>
<pre><span id="VALmake_archive"><span class="keyword">val</span> make_archive</span> : <code class="type">?gener_digest:bool -><br> ?local_path:<a href="OpamTypes.html#TYPEdirname">OpamTypes.dirname</a> -> <a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> -> unit</code></pre><div class="info">
<code class="code">make_archive repo_kind nv</code> build ./$nv.tar.gz, assuming the
repository kind is <code class="code">repo_kind</code>.
By default, the digest that appear in
<i>$NAME.$VERSION/url</i> is not modified,
unless <code class="code">gener_digest = true</code> is given.<br>
</div>
<pre><span id="VALpackages"><span class="keyword">val</span> packages</span> : <code class="type"><a href="OpamPath.Repository.html#TYPEr">OpamPath.Repository.r</a> -> <a href="OpamTypes.html#TYPEpackage_set">OpamTypes.package_set</a></code></pre><div class="info">
Get the list of packages<br>
</div>
<pre><span id="VALcompilers"><span class="keyword">val</span> compilers</span> : <code class="type"><a href="OpamPath.Repository.html#TYPEr">OpamPath.Repository.r</a> -> <a href="OpamTypes.html#TYPEcompiler_set">OpamTypes.compiler_set</a></code></pre><div class="info">
Get the list of compilers<br>
</div>
<pre><span id="VALversions"><span class="keyword">val</span> versions</span> : <code class="type"><a href="OpamPath.Repository.html#TYPEr">OpamPath.Repository.r</a> -> <a href="OpamTypes.html#TYPEname">OpamTypes.name</a> -> <a href="OpamTypes.html#TYPEversion_set">OpamTypes.version_set</a></code></pre><div class="info">
Get the available versions for a given compiler<br>
</div>
<pre><span id="VALfiles"><span class="keyword">val</span> files</span> : <code class="type"><a href="OpamPath.Repository.html#TYPEr">OpamPath.Repository.r</a> -> <a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> -> <a href="OpamTypes.html#TYPEfilename_set">OpamTypes.filename_set</a></code></pre><div class="info">
Get the external files associated to a package<br>
</div>
</body></html>