Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

[doc] update API

  • Loading branch information...
commit 4c6c99864f5c9ee6d71445d4d9bf3be36b1c7159 1 parent aeaafa7
@tuong tuong authored
View
2  doc/html/Client.html
@@ -86,7 +86,7 @@
<code class="code">compiler_list</code> list the available compiler descriptions<br>
</div>
<pre><span id="VALpin"><span class="keyword">val</span> pin</span> : <code class="type"><a href="Types.html#TYPEpin">Types.pin</a> -> unit</code></pre><div class="info">
-Pin a package to a specific version<br>
+Pin a package to a specific version. Take the global file lock.<br>
</div>
<pre><span id="VALpin_list"><span class="keyword">val</span> pin_list</span> : <code class="type">unit -> unit</code></pre><div class="info">
list the current pinned packages<br>
View
2  doc/html/File.Config.html
@@ -32,7 +32,7 @@
<pre><span class="keyword">module</span> Config: <code class="code">sig</code> <a href="File.Config.html">..</a> <code class="code">end</code></pre>Configuration file: <code class="code">$opam/config</code><br>
<hr width="100%">
<pre><span class="keyword">include</span> <a href="File.IO_FILE.html">File.IO_FILE</a></pre>
-<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">Types.OPAM_V.t -><br> <a href="Types.html#TYPErepository">Types.repository</a> list -> Types.Alias.t -> Types.OCaml_V.t option -> int -> t</code></pre><div class="info">
+<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">Types.OPAM_V.t -> <a href="Types.html#TYPErepository">Types.repository</a> list -> int -> t</code></pre><div class="info">
Creation<br>
</div>
<pre><span id="VALwith_ocaml_version"><span class="keyword">val</span> with_ocaml_version</span> : <code class="type">t -> Types.Alias.t -> t</code></pre><div class="info">
View
17 doc/html/Run.html
@@ -60,11 +60,11 @@
</div>
<pre><span id="VALremove_file"><span class="keyword">val</span> remove_file</span> : <code class="type">string -> unit</code></pre><div class="info">
<code class="code">remove_file filename</code> removes <code class="code">filename</code>. Works only for normal
- files<br>
+ files (or also at least for symlinks)<br>
</div>
<pre><span id="VALremove_dir"><span class="keyword">val</span> remove_dir</span> : <code class="type">string -> unit</code></pre><div class="info">
<code class="code">remove_dir filename</code> removes <code class="code">filename</code>. Works only for
- directory.<br>
+ directory (not for symlinks or other files).<br>
</div>
<pre><span id="VALchdir"><span class="keyword">val</span> chdir</span> : <code class="type">string -> unit</code></pre><div class="info">
Change the current working directory<br>
@@ -72,12 +72,14 @@
<pre><span id="VALin_dir"><span class="keyword">val</span> in_dir</span> : <code class="type">string -> (unit -> 'a) -> 'a</code></pre><div class="info">
<code class="code">in_dir dir fn</code> evaluates <code class="code">fn</code> in the directory <code class="code">dir</code><br>
</div>
-<pre><span id="VALfiles"><span class="keyword">val</span> files</span> : <code class="type">string -> string list</code></pre><div class="info">
-<code class="code">files dir</code> returns the files in the directory <code class="code">dir</code><br>
+<pre><span id="VALfiles_with_links"><span class="keyword">val</span> files_with_links</span> : <code class="type">string -> string list</code></pre><div class="info">
+<code class="code">files_with_links dir</code> returns the files in the directory <code class="code">dir</code>.
+ Links simulating directory are ignored, others links are returned.<br>
</div>
<pre><span id="VALrec_files"><span class="keyword">val</span> rec_files</span> : <code class="type">string -> string list</code></pre><div class="info">
<code class="code">rec_files dir</code> returns the list of all files in <code class="code">dir</code>,
- recursively<br>
+ recursively.
+ Links behaving like directory are crossed.<br>
</div>
<pre><span id="VALocaml_version"><span class="keyword">val</span> ocaml_version</span> : <code class="type">unit -> string option</code></pre><div class="info">
Return the version of the current OCaml compiler. If no OCaml
@@ -86,8 +88,9 @@
<pre><span id="VALocamlc_where"><span class="keyword">val</span> ocamlc_where</span> : <code class="type">unit -> string option</code></pre><div class="info">
Return the path where ocamlc library is installed<br>
</div>
-<pre><span id="VALdirectories"><span class="keyword">val</span> directories</span> : <code class="type">string -> string list</code></pre><div class="info">
-<code class="code">files dir</code> returns the directories in the directory <code class="code">dir</code><br>
+<pre><span id="VALdirectories_with_links"><span class="keyword">val</span> directories_with_links</span> : <code class="type">string -> string list</code></pre><div class="info">
+<code class="code">directories_with_links dir</code> returns the directories in the directory <code class="code">dir</code>.
+ Links pointing to directory are also returned.<br>
</div>
<pre><span id="TYPEcommand"><span class="keyword">type</span> <code class="type"></code>command</span> = <code class="type">string list</code> </pre>
<div class="info">
View
12 doc/html/index_values.html
@@ -542,9 +542,9 @@
Description files folder: <i>$opam/descr/</i>
</div>
</td></tr>
-<tr><td><a href="Run.html#VALdirectories">directories</a> [<a href="Run.html">Run</a>]</td>
+<tr><td><a href="Run.html#VALdirectories_with_links">directories_with_links</a> [<a href="Run.html">Run</a>]</td>
<td><div class="info">
-<code class="code">files dir</code> returns the directories in the directory <code class="code">dir</code>
+<code class="code">directories_with_links dir</code> returns the directories in the directory <code class="code">dir</code>.
</div>
</td></tr>
<tr><td><a href="Types.Filename.html#VALdirname">dirname</a> [<a href="Types.Filename.html">Types.Filename</a>]</td>
@@ -623,9 +623,9 @@
</div>
</td></tr>
<tr><td align="left"><br>F</td></tr>
-<tr><td><a href="Run.html#VALfiles">files</a> [<a href="Run.html">Run</a>]</td>
+<tr><td><a href="Run.html#VALfiles_with_links">files_with_links</a> [<a href="Run.html">Run</a>]</td>
<td><div class="info">
-<code class="code">files dir</code> returns the files in the directory <code class="code">dir</code>
+<code class="code">files_with_links dir</code> returns the files in the directory <code class="code">dir</code>.
</div>
</td></tr>
<tr><td><a href="Solver.html#VALfilter_backward_dependencies">filter_backward_dependencies</a> [<a href="Solver.html">Solver</a>]</td>
@@ -1192,7 +1192,7 @@
</td></tr>
<tr><td><a href="Client.html#VALpin">pin</a> [<a href="Client.html">Client</a>]</td>
<td><div class="info">
-Pin a package to a specific version
+Pin a package to a specific version.
</div>
</td></tr>
<tr><td><a href="Client.html#VALpin_list">pin_list</a> [<a href="Client.html">Client</a>]</td>
@@ -1261,7 +1261,7 @@
<tr><td><a href="Run.html#VALrec_files">rec_files</a> [<a href="Run.html">Run</a>]</td>
<td><div class="info">
<code class="code">rec_files dir</code> returns the list of all files in <code class="code">dir</code>,
- recursively
+ recursively.
</div>
</td></tr>
<tr><td><a href="Types.Filename.html#VALrec_list">rec_list</a> [<a href="Types.Filename.html">Types.Filename</a>]</td>
View
5 doc/html/type_File.Config.html
@@ -28,10 +28,7 @@
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;safe_read&nbsp;:&nbsp;<span class="constructor">Types</span>.filename&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;t<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;to_raw&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.raw<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;of_raw&nbsp;:&nbsp;<span class="constructor">Types</span>.raw&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;t<br>
-&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;create&nbsp;:<br>
-&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">Types</span>.<span class="constructor">OPAM_V</span>.t&nbsp;<span class="keywordsign">-&gt;</span><br>
-&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">Types</span>.repository&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span><br>
-&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">Types</span>.<span class="constructor">Alias</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.<span class="constructor">OCaml_V</span>.t&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;int&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;t<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;create&nbsp;:&nbsp;<span class="constructor">Types</span>.<span class="constructor">OPAM_V</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.repository&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;int&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;t<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;with_ocaml_version&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.<span class="constructor">Alias</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;t<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;with_repositories&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.repository&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;t<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;with_last_ocaml_in_path&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.<span class="constructor">OCaml_V</span>.t&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;t<br>
View
5 doc/html/type_File.html
@@ -40,10 +40,7 @@
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;safe_read&nbsp;:&nbsp;<span class="constructor">Types</span>.filename&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;t<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;to_raw&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.raw<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;of_raw&nbsp;:&nbsp;<span class="constructor">Types</span>.raw&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;t<br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;create&nbsp;:<br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">Types</span>.<span class="constructor">OPAM_V</span>.t&nbsp;<span class="keywordsign">-&gt;</span><br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">Types</span>.repository&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span><br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">Types</span>.<span class="constructor">Alias</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.<span class="constructor">OCaml_V</span>.t&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;int&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;t<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;create&nbsp;:&nbsp;<span class="constructor">Types</span>.<span class="constructor">OPAM_V</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.repository&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;int&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;t<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;with_ocaml_version&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.<span class="constructor">Alias</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;t<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;with_repositories&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.repository&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;t<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;with_last_ocaml_in_path&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.<span class="constructor">OCaml_V</span>.t&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;t<br>
View
4 doc/html/type_Run.html
@@ -32,11 +32,11 @@
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;remove_dir&nbsp;:&nbsp;string&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;chdir&nbsp;:&nbsp;string&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;in_dir&nbsp;:&nbsp;string&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;(unit&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="keywordsign">'</span>a)&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="keywordsign">'</span>a<br>
-&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;files&nbsp;:&nbsp;string&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;files_with_links&nbsp;:&nbsp;string&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;rec_files&nbsp;:&nbsp;string&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;ocaml_version&nbsp;:&nbsp;unit&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;option<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;ocamlc_where&nbsp;:&nbsp;unit&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;option<br>
-&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;directories&nbsp;:&nbsp;string&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;directories_with_links&nbsp;:&nbsp;string&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
&nbsp;&nbsp;<span class="keyword">type</span>&nbsp;command&nbsp;=&nbsp;string&nbsp;list<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;command&nbsp;:<br>
&nbsp;&nbsp;&nbsp;&nbsp;?add_to_env:(string&nbsp;*&nbsp;string)&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span><br>
Please sign in to comment.
Something went wrong with that request. Please try again.