Update documentation
This commit is contained in:
Ganesh Viswanathan
parent
3d52e60b8b
commit
edc1366f14
14 changed files with 139 additions and 1149 deletions
2
all.html
2
all.html
|
|
@ -850,7 +850,7 @@ function main() {
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small>Made with Nim. Generated: 2019-10-04 01:43:49 UTC</small>
|
||||
<small>Made with Nim. Generated: 2019-10-10 23:38:17 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
73
build.html
73
build.html
|
|
@ -849,7 +849,9 @@ function main() {
|
|||
<li><a class="reference" href="#rmFile%2Cstring"
|
||||
title="rmFile(source: string; dir = false)"><wbr />rm<wbr />File<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#rmDir%2Cstring"
|
||||
title="rmDir(source: string)"><wbr />rm<wbr />Dir<span class="attachedType"></span></a></li>
|
||||
title="rmDir(dir: string)"><wbr />rm<wbr />Dir<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#getProjectCacheDir%2Cstring"
|
||||
title="getProjectCacheDir(name: string; forceClean = true): string"><wbr />get<wbr />Project<wbr />Cache<wbr />Dir<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#extractZip%2Cstring%2Cstring"
|
||||
title="extractZip(zipfile, outdir: string)"><wbr />extract<wbr />Zip<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#extractTar%2Cstring%2Cstring"
|
||||
|
|
@ -862,10 +864,12 @@ function main() {
|
|||
title="gitCheckout(file, outdir: string)"><wbr />git<wbr />Checkout<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#gitPull%2Cstring%2Cstring%2Cstring%2Cstring"
|
||||
title="gitPull(url: string; outdir = ""; plist = ""; checkout = "")"><wbr />git<wbr />Pull<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#findFile%2C%2Cstring"
|
||||
title="findFile(file: string | Regex; dir: string; recurse = true; first = false): string"><wbr />find<wbr />File<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#findFile%2Cstring%2Cstring"
|
||||
title="findFile(file: string; dir: string; recurse = true; first = false; regex = false): string"><wbr />find<wbr />File<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#flagBuild%2Cstring%2CopenArray%5Bstring%5D"
|
||||
title="flagBuild(base: string; flags: openArray[string]): string"><wbr />flag<wbr />Build<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#linkLibs%2CopenArray%5Bstring%5D"
|
||||
title="linkLibs(names: openArray[string]; staticLink = true): string"><wbr />link<wbr />Libs<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#configure%2Cstring%2Cstring%2Cstring"
|
||||
title="configure(path, check: string; flags = "")"><wbr />configure<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#getCmakeIncludePath%2CopenArray%5Bstring%5D"
|
||||
|
|
@ -878,8 +882,8 @@ function main() {
|
|||
title="setCmakePositionIndependentCode(outdir: string)"><wbr />set<wbr />Cmake<wbr />Position<wbr />Independent<wbr />Code<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#cmake%2Cstring%2Cstring%2Cstring"
|
||||
title="cmake(path, check, flags: string)"><wbr />cmake<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#make%2C%2C%2Cstring"
|
||||
title="make(path, check: string | Regex; flags = "")"><wbr />make<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#make%2Cstring%2Cstring%2Cstring"
|
||||
title="make(path, check: string; flags = ""; regex = false)"><wbr />make<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#getGccPaths%2Cstring"
|
||||
title="getGccPaths(mode = "c"): seq[string]"><wbr />get<wbr />Gcc<wbr />Paths<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#getGccLibPaths%2Cstring"
|
||||
|
|
@ -894,6 +898,8 @@ function main() {
|
|||
title="setDefines(defs: static openArray[string]): untyped"><wbr />set<wbr />Defines<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#clearDefines.m"
|
||||
title="clearDefines(): untyped"><wbr />clear<wbr />Defines<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#isDefined.m%2Cuntyped"
|
||||
title="isDefined(def: untyped): untyped"><wbr />is<wbr />Defined<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#getHeader.m%2Cstatic%5Bstring%5D%2Cstatic%5Bstring%5D%2Cstatic%5Bstring%5D%2Cstatic%5Bstring%5D%2Cstatic%5Bstring%5D%2Cstatic%5Bstring%5D%2Cstatic%5Bstring%5D%2Cstatic%5Bstring%5D"
|
||||
title="getHeader(header: static[string]; giturl: static[string] = "";
|
||||
dlurl: static[string] = ""; outdir: static[string] = "";
|
||||
|
|
@ -987,12 +993,31 @@ Remove a file or pattern at compile time
|
|||
|
||||
</dd>
|
||||
<a id="rmDir,string"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#rmDir%2Cstring"><span class="Identifier">rmDir</span></a><span class="Other">(</span><span class="Identifier">source</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">Defect</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ExecIOEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#rmDir%2Cstring"><span class="Identifier">rmDir</span></a><span class="Other">(</span><span class="Identifier">dir</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">Defect</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ExecIOEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
Remove a directory or pattern at compile time
|
||||
|
||||
</dd>
|
||||
<a id="getProjectCacheDir,string"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#getProjectCacheDir%2Cstring"><span class="Identifier">getProjectCacheDir</span></a><span class="Other">(</span><span class="Identifier">name</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">forceClean</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">Defect</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadEnvEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">ExecIOEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<p>Get a cache directory where all nimterop artifacts can be stored</p>
|
||||
<p>Projects can use this location to download source code and build binaries that can be then accessed by multiple apps. This is created under the per-user Nim cache directory.</p>
|
||||
<p>Use <tt class="docutils literal"><span class="pre">name</span></tt> to specify the subdirectory name for a project.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">forceClean</span></tt> is enabled by default and effectively deletes the folder if Nim is compiled with the <tt class="docutils literal"><span class="pre">-f</span></tt> or <tt class="docutils literal"><span class="pre">--forceBuild</span></tt> flag. This allows any project to start out with a clean cache dir on a forced build.</p>
|
||||
<p>NOTE: avoid calling <tt class="docutils literal"><span class="pre">getProjectCacheDir()</span></tt> multiple times on the same <tt class="docutils literal"><span class="pre">name</span></tt> when <tt class="docutils literal"><span class="pre">forceClean = true</span></tt> else checked out source might get deleted at the wrong time during build.</p>
|
||||
<dl class="docutils"><dt>E.g.</dt>
|
||||
<dd><p><tt class="docutils literal"><span class="pre">nimgit2</span></tt> downloads <tt class="docutils literal"><span class="pre">libgit2</span></tt> source so <tt class="docutils literal"><span class="pre">name = "libgit2"</span></tt></p>
|
||||
<p><tt class="docutils literal"><span class="pre">nimarchive</span></tt> downloads <tt class="docutils literal"><span class="pre">libarchive</span></tt>, <tt class="docutils literal"><span class="pre">bzlib</span></tt>, <tt class="docutils literal"><span class="pre">liblzma</span></tt> and <tt class="docutils literal"><span class="pre">zlib</span></tt> so <tt class="docutils literal"><span class="pre">name = "nimarchive" / "libarchive"</span></tt> for <tt class="docutils literal"><span class="pre">libarchive</span></tt>, etc.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="extractZip,string,string"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#extractZip%2Cstring%2Cstring"><span class="Identifier">extractZip</span></a><span class="Other">(</span><span class="Identifier">zipfile</span><span class="Other">,</span> <span class="Identifier">outdir</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">Defect</span><span class="Other">,</span>
|
||||
|
|
@ -1050,12 +1075,13 @@ Hard reset the git repository at the specified directory
|
|||
|
||||
|
||||
</dd>
|
||||
<a id="findFile,,string"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#findFile%2C%2Cstring"><span class="Identifier">findFile</span></a><span class="Other">(</span><span class="Identifier">file</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Operator">|</span> <span class="Identifier">Regex</span><span class="Other">;</span> <span class="Identifier">dir</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">recurse</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">;</span> <span class="Identifier">first</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span></pre></dt>
|
||||
<a id="findFile,string,string"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#findFile%2Cstring%2Cstring"><span class="Identifier">findFile</span></a><span class="Other">(</span><span class="Identifier">file</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">dir</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">recurse</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">;</span> <span class="Identifier">first</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">;</span> <span class="Identifier">regex</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<p>Find the file in the specified directory</p>
|
||||
<p><tt class="docutils literal"><span class="pre">file</span></tt> can be a string or a regex object</p>
|
||||
<p><tt class="docutils literal"><span class="pre">file</span></tt> is a regular expression if <tt class="docutils literal"><span class="pre">regex</span></tt> is true</p>
|
||||
<p>Turn off recursive search with <tt class="docutils literal"><span class="pre">recurse</span></tt> and stop on first match with <tt class="docutils literal"><span class="pre">first</span></tt>. Without it, the shortest match is returned.</p>
|
||||
|
||||
|
||||
|
|
@ -1073,6 +1099,16 @@ Hard reset the git repository at the specified directory
|
|||
<p><tt class="docutils literal"><span class="pre">flagBuild(base, flags) => " --disable-one --disable-two"</span></tt></p>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="linkLibs,openArray[string]"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#linkLibs%2CopenArray%5Bstring%5D"><span class="Identifier">linkLibs</span></a><span class="Other">(</span><span class="Identifier">names</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">staticLink</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<p>Create linker flags for specified libraries</p>
|
||||
<p>Prepends <tt class="docutils literal"><span class="pre">lib</span></tt> to the name so you only need <tt class="docutils literal"><span class="pre">ssl</span></tt> for <tt class="docutils literal"><span class="pre">libssl</span></tt>.</p>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="configure,string,string,string"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#configure%2Cstring%2Cstring%2Cstring"><span class="Identifier">configure</span></a><span class="Other">(</span><span class="Identifier">path</span><span class="Other">,</span> <span class="Identifier">check</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">flags</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
|
|
@ -1145,13 +1181,16 @@ Set a <tt class="docutils literal"><span class="pre">cmake</span></tt> directive
|
|||
|
||||
|
||||
</dd>
|
||||
<a id="make,,,string"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#make%2C%2C%2Cstring"><span class="Identifier">make</span></a><span class="Other">(</span><span class="Identifier">path</span><span class="Other">,</span> <span class="Identifier">check</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Operator">|</span> <span class="Identifier">Regex</span><span class="Other">;</span> <span class="Identifier">flags</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">)</span></pre></dt>
|
||||
<a id="make,string,string,string"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#make%2Cstring%2Cstring%2Cstring"><span class="Identifier">make</span></a><span class="Other">(</span><span class="Identifier">path</span><span class="Other">,</span> <span class="Identifier">check</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">flags</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">;</span> <span class="Identifier">regex</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">Defect</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ExecIOEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<p>Run the <tt class="docutils literal"><span class="pre">make</span></tt> command to build all binaries in the specified path</p>
|
||||
<p><tt class="docutils literal"><span class="pre">check</span></tt> is a file that will be generated by the <tt class="docutils literal"><span class="pre">make</span></tt> command. This is required to prevent <tt class="docutils literal"><span class="pre">make</span></tt> from running on every build. It is relative to the <tt class="docutils literal"><span class="pre">path</span></tt> and should not be an absolute path.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">flags</span></tt> are any flags that should be passed to the <tt class="docutils literal"><span class="pre">make</span></tt> command.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">regex</span></tt> can be set to true if <tt class="docutils literal"><span class="pre">check</span></tt> is a regular expression.</p>
|
||||
<p>If <tt class="docutils literal"><span class="pre">make.exe</span></tt> is missing and <tt class="docutils literal"><span class="pre">mingw32-make.exe</span></tt> is available, it will be copied over to make.exe in the same location.</p>
|
||||
|
||||
|
||||
|
|
@ -1196,6 +1235,13 @@ Set a <tt class="docutils literal"><span class="pre">cmake</span></tt> directive
|
|||
|
||||
Clear all defines set using <tt class="docutils literal"><span class="pre">setDefines()</span></tt>.
|
||||
|
||||
</dd>
|
||||
<a id="isDefined.m,untyped"></a>
|
||||
<dt><pre><span class="Keyword">macro</span> <a href="#isDefined.m%2Cuntyped"><span class="Identifier">isDefined</span></a><span class="Other">(</span><span class="Identifier">def</span><span class="Other">:</span> <span class="Identifier">untyped</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
Check if <tt class="docutils literal"><span class="pre">-d:xxx</span></tt> is set globally or via <tt class="docutils literal"><span class="pre">setDefines()</span></tt>
|
||||
|
||||
</dd>
|
||||
<a id="getHeader.m,static[string],static[string],static[string],static[string],static[string],static[string],static[string],static[string]"></a>
|
||||
<dt><pre><span class="Keyword">macro</span> <a href="#getHeader.m%2Cstatic%5Bstring%5D%2Cstatic%5Bstring%5D%2Cstatic%5Bstring%5D%2Cstatic%5Bstring%5D%2Cstatic%5Bstring%5D%2Cstatic%5Bstring%5D%2Cstatic%5Bstring%5D%2Cstatic%5Bstring%5D"><span class="Identifier">getHeader</span></a><span class="Other">(</span><span class="Identifier">header</span><span class="Other">:</span> <span class="Identifier">static</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">giturl</span><span class="Other">:</span> <span class="Identifier">static</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">;</span>
|
||||
|
|
@ -1208,6 +1254,7 @@ Clear all defines set using <tt class="docutils literal"><span class="pre">setDe
|
|||
<p>This proc checks <tt class="docutils literal"><span class="pre">-d:xxx</span></tt> defines based on the header name (e.g. lzma from lzma.h), and accordingly employs different ways to obtain the source.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">-d:xxxStd</span></tt> - search standard system paths. E.g. <tt class="docutils literal"><span class="pre">/usr/include</span></tt> and <tt class="docutils literal"><span class="pre">/usr/lib</span></tt> on Linux <tt class="docutils literal"><span class="pre">-d:xxxGit</span></tt> - clone source from a git repo specified in <tt class="docutils literal"><span class="pre">giturl</span></tt> <tt class="docutils literal"><span class="pre">-d:xxxDL</span></tt> - download source from <tt class="docutils literal"><span class="pre">dlurl</span></tt> and extract if required</p>
|
||||
<p>This allows a single wrapper to be used in different ways depending on the user's needs. If no <tt class="docutils literal"><span class="pre">-d:xxx</span></tt> defines are specified, <tt class="docutils literal"><span class="pre">outdir</span></tt> will be searched for the header as is.</p>
|
||||
<p>If multiple <tt class="docutils literal"><span class="pre">-d:xxx</span></tt> defines are specified, precedence is <tt class="docutils literal"><span class="pre">Std</span></tt> and then <tt class="docutils literal"><span class="pre">Git</span></tt> or <tt class="docutils literal"><span class="pre">DL</span></tt>. This allows using a system installed library if available before falling back to manual building.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">-d:xxxSetVer=x.y.z</span></tt> can be used to specify which version to use. It is used as a tag name for Git whereas for DL, it replaces <tt class="docutils literal"><span class="pre">$1</span></tt> in the URL defined.</p>
|
||||
<p>All defines can also be set in code using <tt class="docutils literal"><span class="pre">setDefines()</span></tt>.</p>
|
||||
<p>The library is then configured (with <tt class="docutils literal"><span class="pre">cmake</span></tt> or <tt class="docutils literal"><span class="pre">autotools</span></tt> if possible) and built using <tt class="docutils literal"><span class="pre">make</span></tt>, unless using <tt class="docutils literal"><span class="pre">-d:xxxStd</span></tt> which presumes that the system package manager was used to install prebuilt headers and binaries.</p>
|
||||
|
|
@ -1231,7 +1278,7 @@ Clear all defines set using <tt class="docutils literal"><span class="pre">setDe
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small>Made with Nim. Generated: 2019-10-04 01:43:48 UTC</small>
|
||||
<small>Made with Nim. Generated: 2019-10-10 23:38:15 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,24 +6,27 @@ mkDir build.html#mkDir,string build: mkDir(dir: string)
|
|||
cpFile build.html#cpFile,string,string build: cpFile(source, dest: string; move = false)
|
||||
mvFile build.html#mvFile,string,string build: mvFile(source, dest: string)
|
||||
rmFile build.html#rmFile,string build: rmFile(source: string; dir = false)
|
||||
rmDir build.html#rmDir,string build: rmDir(source: string)
|
||||
rmDir build.html#rmDir,string build: rmDir(dir: string)
|
||||
getProjectCacheDir build.html#getProjectCacheDir,string build: getProjectCacheDir(name: string; forceClean = true): string
|
||||
extractZip build.html#extractZip,string,string build: extractZip(zipfile, outdir: string)
|
||||
extractTar build.html#extractTar,string,string build: extractTar(tarfile, outdir: string)
|
||||
downloadUrl build.html#downloadUrl,string,string build: downloadUrl(url, outdir: string)
|
||||
gitReset build.html#gitReset,string build: gitReset(outdir: string)
|
||||
gitCheckout build.html#gitCheckout,string,string build: gitCheckout(file, outdir: string)
|
||||
gitPull build.html#gitPull,string,string,string,string build: gitPull(url: string; outdir = ""; plist = ""; checkout = "")
|
||||
findFile build.html#findFile,,string build: findFile(file: string | Regex; dir: string; recurse = true; first = false): string
|
||||
findFile build.html#findFile,string,string build: findFile(file: string; dir: string; recurse = true; first = false; regex = false): string
|
||||
flagBuild build.html#flagBuild,string,openArray[string] build: flagBuild(base: string; flags: openArray[string]): string
|
||||
linkLibs build.html#linkLibs,openArray[string] build: linkLibs(names: openArray[string]; staticLink = true): string
|
||||
configure build.html#configure,string,string,string build: configure(path, check: string; flags = "")
|
||||
getCmakeIncludePath build.html#getCmakeIncludePath,openArray[string] build: getCmakeIncludePath(paths: openArray[string]): string
|
||||
setCmakeProperty build.html#setCmakeProperty,string,string,string,string build: setCmakeProperty(outdir, name, property, value: string)
|
||||
setCmakeLibName build.html#setCmakeLibName,string,string,string,string,string build: setCmakeLibName(outdir, name, prefix = ""; oname = ""; suffix = "")
|
||||
setCmakePositionIndependentCode build.html#setCmakePositionIndependentCode,string build: setCmakePositionIndependentCode(outdir: string)
|
||||
cmake build.html#cmake,string,string,string build: cmake(path, check, flags: string)
|
||||
make build.html#make,,,string build: make(path, check: string | Regex; flags = "")
|
||||
make build.html#make,string,string,string build: make(path, check: string; flags = ""; regex = false)
|
||||
getGccPaths build.html#getGccPaths,string build: getGccPaths(mode = "c"): seq[string]
|
||||
getGccLibPaths build.html#getGccLibPaths,string build: getGccLibPaths(mode = "c"): seq[string]
|
||||
setDefines build.html#setDefines.m build: setDefines(defs: static openArray[string]): untyped
|
||||
clearDefines build.html#clearDefines.m build: clearDefines(): untyped
|
||||
isDefined build.html#isDefined.m,untyped build: isDefined(def: untyped): untyped
|
||||
getHeader build.html#getHeader.m,static[string],static[string],static[string],static[string],static[string],static[string],static[string],static[string] build: getHeader(header: static[string]; giturl: static[string] = "";\n dlurl: static[string] = ""; outdir: static[string] = "";\n conFlags: static[string] = ""; cmakeFlags: static[string] = "";\n makeFlags: static[string] = ""; altNames: static[string] = ""): untyped
|
||||
|
|
|
|||
|
|
@ -1090,7 +1090,7 @@ Add an include directory that is forwarded to the C/C++ preprocessor if called w
|
|||
<div class="section" id="19">
|
||||
<h1><a class="toc-backref" href="#19">Exports</a></h1>
|
||||
<dl class="item">
|
||||
<a href="types.html#time_t"><span class="Identifier">time_t</span></a>, <a href="types.html#defineEnum"><span class="Identifier">defineEnum</span></a>, <a href="types.html#wchar_t"><span class="Identifier">wchar_t</span></a>, <a href="types.html#va_list"><span class="Identifier">va_list</span></a>, <a class="reference external" href="types.html">types</a>, <a href="types.html#enumOp"><span class="Identifier">enumOp</span></a>, <a href="types.html#ptrdiff_t"><span class="Identifier">ptrdiff_t</span></a>
|
||||
<a href="types.html#va_list"><span class="Identifier">va_list</span></a>, <a href="types.html#defineEnum"><span class="Identifier">defineEnum</span></a>, <a href="types.html#wchar_t"><span class="Identifier">wchar_t</span></a>, <a href="types.html#time_t"><span class="Identifier">time_t</span></a>, <a href="types.html#time64_t"><span class="Identifier">time64_t</span></a>, <a class="reference external" href="types.html">types</a>, <a href="types.html#enumOp"><span class="Identifier">enumOp</span></a>, <a href="types.html#ptrdiff_t"><span class="Identifier">ptrdiff_t</span></a>
|
||||
</dl></div>
|
||||
|
||||
</div>
|
||||
|
|
@ -1100,7 +1100,7 @@ Add an include directory that is forwarded to the C/C++ preprocessor if called w
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small>Made with Nim. Generated: 2019-10-04 01:43:49 UTC</small>
|
||||
<small>Made with Nim. Generated: 2019-10-10 23:38:17 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -859,7 +859,7 @@ function main() {
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small>Made with Nim. Generated: 2019-10-04 01:43:48 UTC</small>
|
||||
<small>Made with Nim. Generated: 2019-10-10 23:38:15 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -601,7 +601,6 @@ function nimMin(a_65203, b_65204) {
|
|||
return result_65205;
|
||||
|
||||
}
|
||||
var nimvm_49710 = false;
|
||||
var nim_program_result = 0;
|
||||
var global_raise_hook_59618 = [null];
|
||||
var local_raise_hook_59623 = [null];
|
||||
|
|
|
|||
15
git.idx
15
git.idx
|
|
@ -1,15 +0,0 @@
|
|||
execAction git.html#execAction,string git: execAction(cmd: string; nostderr = false): string
|
||||
findExe git.html#findExe,string git: findExe(exe: string): string
|
||||
mkDir git.html#mkDir,string git: mkDir(dir: string)
|
||||
cpFile git.html#cpFile,string,string git: cpFile(source, dest: string; move = false)
|
||||
mvFile git.html#mvFile,string,string git: mvFile(source, dest: string)
|
||||
rmFile git.html#rmFile,string git: rmFile(source: string; dir = false)
|
||||
rmDir git.html#rmDir,string git: rmDir(source: string)
|
||||
extractZip git.html#extractZip,string,string git: extractZip(zipfile, outdir: string)
|
||||
downloadUrl git.html#downloadUrl,string,string git: downloadUrl(url, outdir: string)
|
||||
gitReset git.html#gitReset,string git: gitReset(outdir: string)
|
||||
gitCheckout git.html#gitCheckout,string,string git: gitCheckout(file, outdir: string)
|
||||
gitPull git.html#gitPull,string,string,string,string git: gitPull(url: string; outdir = ""; plist = ""; checkout = "")
|
||||
configure git.html#configure,string,string,string git: configure(path, check: string; flags = "")
|
||||
cmake git.html#cmake,string,string,string git: cmake(path, check, flags: string)
|
||||
make git.html#make,string,string,string git: make(path, check: string; flags = "")
|
||||
53
paths.html
53
paths.html
|
|
@ -823,19 +823,29 @@ function main() {
|
|||
</select>
|
||||
</div>
|
||||
<ul class="simple simple-toc" id="toc-list">
|
||||
<li>
|
||||
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a class="reference reference-toplevel" href="#10" id="60">Consts</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<li><a class="reference" href="#cacheDir"
|
||||
title="cacheDir = "/home/genotrance/.cache/nim/nimterop/nimterop""><wbr />cache<wbr />Dir<span class="attachedType"></span></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<li><a class="reference" href="#nimteropRoot"
|
||||
title="nimteropRoot(): string"><wbr />nimterop<wbr />Root<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#nimteropBuildDir"
|
||||
title="nimteropBuildDir(): string"><wbr />nimterop<wbr />Build<wbr />Dir<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#nimteropSrcDir"
|
||||
title="nimteropSrcDir(): string"><wbr />nimterop<wbr />Src<wbr />Dir<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#toastExePath"
|
||||
title="toastExePath(): string"><wbr />toast<wbr />Exe<wbr />Path<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#incDir"
|
||||
title="incDir(): string"><wbr />inc<wbr />Dir<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#testsIncludeDir"
|
||||
title="testsIncludeDir(): string"><wbr />tests<wbr />Include<wbr />Dir<span class="attachedType"></span></a></li>
|
||||
|
||||
|
|
@ -849,7 +859,24 @@ function main() {
|
|||
<div id="tocRoot"></div>
|
||||
|
||||
<p class="module-desc"></p>
|
||||
<div class="section" id="12">
|
||||
<div class="section" id="6">
|
||||
<h1><a class="toc-backref" href="#6">Imports</a></h1>
|
||||
<dl class="item">
|
||||
<a class="reference external" href="build.html">build</a>
|
||||
</dl></div>
|
||||
<div class="section" id="10">
|
||||
<h1><a class="toc-backref" href="#10">Consts</a></h1>
|
||||
<dl class="item">
|
||||
<a id="cacheDir"></a>
|
||||
<dt><pre><a href="paths.html#cacheDir"><span class="Identifier">cacheDir</span></a> <span class="Other">=</span> <span class="StringLit">"/home/genotrance/.cache/nim/nimterop/nimterop"</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
|
||||
</dl></div>
|
||||
<div class="section" id="12">
|
||||
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
||||
<dl class="item">
|
||||
<a id="nimteropRoot"></a>
|
||||
|
|
@ -858,13 +885,6 @@ function main() {
|
|||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="nimteropBuildDir"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#nimteropBuildDir"><span class="Identifier">nimteropBuildDir</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
all nimterop generated files go under here (gitignored)
|
||||
|
||||
</dd>
|
||||
<a id="nimteropSrcDir"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#nimteropSrcDir"><span class="Identifier">nimteropSrcDir</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
|
|
@ -879,13 +899,6 @@ all nimterop generated files go under here (gitignored)
|
|||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="incDir"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#incDir"><span class="Identifier">incDir</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="testsIncludeDir"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#testsIncludeDir"><span class="Identifier">testsIncludeDir</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
|
|
@ -904,7 +917,7 @@ all nimterop generated files go under here (gitignored)
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small>Made with Nim. Generated: 2019-10-04 01:43:48 UTC</small>
|
||||
<small>Made with Nim. Generated: 2019-10-10 23:38:15 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
cacheDir paths.html#cacheDir paths: cacheDir
|
||||
nimteropRoot paths.html#nimteropRoot paths: nimteropRoot(): string
|
||||
nimteropBuildDir paths.html#nimteropBuildDir paths: nimteropBuildDir(): string
|
||||
nimteropSrcDir paths.html#nimteropSrcDir paths: nimteropSrcDir(): string
|
||||
toastExePath paths.html#toastExePath paths: toastExePath(): string
|
||||
incDir paths.html#incDir paths: incDir(): string
|
||||
testsIncludeDir paths.html#testsIncludeDir paths: testsIncludeDir(): string
|
||||
|
|
|
|||
|
|
@ -875,7 +875,7 @@ function main() {
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small>Made with Nim. Generated: 2019-10-04 01:43:48 UTC</small>
|
||||
<small>Made with Nim. Generated: 2019-10-10 23:38:15 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -805,13 +805,17 @@ function main() {
|
|||
<div class="document" id="documentId">
|
||||
<div class="container">
|
||||
<h1 class="title">Index</h1>
|
||||
Modules: <a href="build.html">build</a>, <a href="cimport.html">cimport</a>, <a href="compat.html">compat</a>, <a href="git.html">git</a>, <a href="paths.html">paths</a>, <a href="plugin.html">plugin</a>, <a href="types.html">types</a>.<br/><p /><h2>API symbols</h2>
|
||||
Modules: <a href="build.html">build</a>, <a href="cimport.html">cimport</a>, <a href="compat.html">compat</a>, <a href="paths.html">paths</a>, <a href="plugin.html">plugin</a>, <a href="types.html">types</a>.<br/><p /><h2>API symbols</h2>
|
||||
<dl><dt><a name="c2nImport" href="#c2nImport"><span>c2nImport:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="cimport: c2nImport(filename: static string; recurse: static bool = false;
|
||||
dynlib: static string = ""; mode: static string = "c"; flags: static string = ""): untyped" href="cimport.html#c2nImport.m%2C%2Cstring%2Cstring%2Cstring">cimport: c2nImport(filename: static string; recurse: static bool = false;
|
||||
dynlib: static string = ""; mode: static string = "c"; flags: static string = ""): untyped</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="cacheDir" href="#cacheDir"><span>cacheDir:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="paths: cacheDir" href="paths.html#cacheDir">paths: cacheDir</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="cAddSearchDir" href="#cAddSearchDir"><span>cAddSearchDir:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="cimport: cAddSearchDir(dir: string)" href="cimport.html#cAddSearchDir%2Cstring">cimport: cAddSearchDir(dir: string)</a></li>
|
||||
|
|
@ -853,14 +857,10 @@ function main() {
|
|||
<dt><a name="cmake" href="#cmake"><span>cmake:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: cmake(path, check, flags: string)" href="build.html#cmake%2Cstring%2Cstring%2Cstring">build: cmake(path, check, flags: string)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: cmake(path, check, flags: string)" href="git.html#cmake%2Cstring%2Cstring%2Cstring">git: cmake(path, check, flags: string)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="configure" href="#configure"><span>configure:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: configure(path, check: string; flags = "")" href="build.html#configure%2Cstring%2Cstring%2Cstring">build: configure(path, check: string; flags = "")</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: configure(path, check: string; flags = "")" href="git.html#configure%2Cstring%2Cstring%2Cstring">git: configure(path, check: string; flags = "")</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="cOverride" href="#cOverride"><span>cOverride:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
|
|
@ -869,8 +869,6 @@ function main() {
|
|||
<dt><a name="cpFile" href="#cpFile"><span>cpFile:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: cpFile(source, dest: string; move = false)" href="build.html#cpFile%2Cstring%2Cstring">build: cpFile(source, dest: string; move = false)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: cpFile(source, dest: string; move = false)" href="git.html#cpFile%2Cstring%2Cstring">git: cpFile(source, dest: string; move = false)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="cPlugin" href="#cPlugin"><span>cPlugin:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
|
|
@ -891,8 +889,6 @@ function main() {
|
|||
<dt><a name="downloadUrl" href="#downloadUrl"><span>downloadUrl:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: downloadUrl(url, outdir: string)" href="build.html#downloadUrl%2Cstring%2Cstring">build: downloadUrl(url, outdir: string)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: downloadUrl(url, outdir: string)" href="git.html#downloadUrl%2Cstring%2Cstring">git: downloadUrl(url, outdir: string)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="enumOp" href="#enumOp"><span>enumOp:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
|
|
@ -901,8 +897,6 @@ function main() {
|
|||
<dt><a name="execAction" href="#execAction"><span>execAction:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: execAction(cmd: string; retry = 0; nostderr = false): string" href="build.html#execAction%2Cstring%2Cint">build: execAction(cmd: string; retry = 0; nostderr = false): string</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: execAction(cmd: string; nostderr = false): string" href="git.html#execAction%2Cstring">git: execAction(cmd: string; nostderr = false): string</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="extractTar" href="#extractTar"><span>extractTar:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
|
|
@ -911,18 +905,14 @@ function main() {
|
|||
<dt><a name="extractZip" href="#extractZip"><span>extractZip:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: extractZip(zipfile, outdir: string)" href="build.html#extractZip%2Cstring%2Cstring">build: extractZip(zipfile, outdir: string)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: extractZip(zipfile, outdir: string)" href="git.html#extractZip%2Cstring%2Cstring">git: extractZip(zipfile, outdir: string)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="findExe" href="#findExe"><span>findExe:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: findExe(exe: string): string" href="build.html#findExe%2Cstring">build: findExe(exe: string): string</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: findExe(exe: string): string" href="git.html#findExe%2Cstring">git: findExe(exe: string): string</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="findFile" href="#findFile"><span>findFile:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: findFile(file: string | Regex; dir: string; recurse = true; first = false): string" href="build.html#findFile%2C%2Cstring">build: findFile(file: string | Regex; dir: string; recurse = true; first = false): string</a></li>
|
||||
data-doc-search-tag="build: findFile(file: string; dir: string; recurse = true; first = false; regex = false): string" href="build.html#findFile%2Cstring%2Cstring">build: findFile(file: string; dir: string; recurse = true; first = false; regex = false): string</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="flagBuild" href="#flagBuild"><span>flagBuild:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
|
|
@ -950,54 +940,46 @@ function main() {
|
|||
conFlags: static[string] = ""; cmakeFlags: static[string] = "";
|
||||
makeFlags: static[string] = ""; altNames: static[string] = ""): untyped</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="getProjectCacheDir" href="#getProjectCacheDir"><span>getProjectCacheDir:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: getProjectCacheDir(name: string; forceClean = true): string" href="build.html#getProjectCacheDir%2Cstring">build: getProjectCacheDir(name: string; forceClean = true): string</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="gitCheckout" href="#gitCheckout"><span>gitCheckout:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: gitCheckout(file, outdir: string)" href="build.html#gitCheckout%2Cstring%2Cstring">build: gitCheckout(file, outdir: string)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: gitCheckout(file, outdir: string)" href="git.html#gitCheckout%2Cstring%2Cstring">git: gitCheckout(file, outdir: string)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="gitPull" href="#gitPull"><span>gitPull:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: gitPull(url: string; outdir = ""; plist = ""; checkout = "")" href="build.html#gitPull%2Cstring%2Cstring%2Cstring%2Cstring">build: gitPull(url: string; outdir = ""; plist = ""; checkout = "")</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: gitPull(url: string; outdir = ""; plist = ""; checkout = "")" href="git.html#gitPull%2Cstring%2Cstring%2Cstring%2Cstring">git: gitPull(url: string; outdir = ""; plist = ""; checkout = "")</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="gitReset" href="#gitReset"><span>gitReset:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: gitReset(outdir: string)" href="build.html#gitReset%2Cstring">build: gitReset(outdir: string)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: gitReset(outdir: string)" href="git.html#gitReset%2Cstring">git: gitReset(outdir: string)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="incDir" href="#incDir"><span>incDir:</span></a></dt><dd><ul class="simple">
|
||||
<dt><a name="isDefined" href="#isDefined"><span>isDefined:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="paths: incDir(): string" href="paths.html#incDir">paths: incDir(): string</a></li>
|
||||
data-doc-search-tag="build: isDefined(def: untyped): untyped" href="build.html#isDefined.m%2Cuntyped">build: isDefined(def: untyped): untyped</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="linkLibs" href="#linkLibs"><span>linkLibs:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: linkLibs(names: openArray[string]; staticLink = true): string" href="build.html#linkLibs%2CopenArray%5Bstring%5D">build: linkLibs(names: openArray[string]; staticLink = true): string</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="make" href="#make"><span>make:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: make(path, check: string | Regex; flags = "")" href="build.html#make%2C%2C%2Cstring">build: make(path, check: string | Regex; flags = "")</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: make(path, check: string; flags = "")" href="git.html#make%2Cstring%2Cstring%2Cstring">git: make(path, check: string; flags = "")</a></li>
|
||||
data-doc-search-tag="build: make(path, check: string; flags = ""; regex = false)" href="build.html#make%2Cstring%2Cstring%2Cstring">build: make(path, check: string; flags = ""; regex = false)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="mkDir" href="#mkDir"><span>mkDir:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: mkDir(dir: string)" href="build.html#mkDir%2Cstring">build: mkDir(dir: string)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: mkDir(dir: string)" href="git.html#mkDir%2Cstring">git: mkDir(dir: string)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="mvFile" href="#mvFile"><span>mvFile:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: mvFile(source, dest: string)" href="build.html#mvFile%2Cstring%2Cstring">build: mvFile(source, dest: string)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: mvFile(source, dest: string)" href="git.html#mvFile%2Cstring%2Cstring">git: mvFile(source, dest: string)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="myNormalizedPath" href="#myNormalizedPath"><span>myNormalizedPath:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="compat: myNormalizedPath(path: string): string" href="compat.html#myNormalizedPath%2Cstring">compat: myNormalizedPath(path: string): string</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="nimteropBuildDir" href="#nimteropBuildDir"><span>nimteropBuildDir:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="paths: nimteropBuildDir(): string" href="paths.html#nimteropBuildDir">paths: nimteropBuildDir(): string</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="nimteropRoot" href="#nimteropRoot"><span>nimteropRoot:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="paths: nimteropRoot(): string" href="paths.html#nimteropRoot">paths: nimteropRoot(): string</a></li>
|
||||
|
|
@ -1016,15 +998,11 @@ function main() {
|
|||
</ul></dd>
|
||||
<dt><a name="rmDir" href="#rmDir"><span>rmDir:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: rmDir(source: string)" href="build.html#rmDir%2Cstring">build: rmDir(source: string)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: rmDir(source: string)" href="git.html#rmDir%2Cstring">git: rmDir(source: string)</a></li>
|
||||
data-doc-search-tag="build: rmDir(dir: string)" href="build.html#rmDir%2Cstring">build: rmDir(dir: string)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="rmFile" href="#rmFile"><span>rmFile:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: rmFile(source: string; dir = false)" href="build.html#rmFile%2Cstring">build: rmFile(source: string; dir = false)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: rmFile(source: string; dir = false)" href="git.html#rmFile%2Cstring">git: rmFile(source: string; dir = false)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="sanitizePath" href="#sanitizePath"><span>sanitizePath:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
|
|
@ -1058,6 +1036,10 @@ function main() {
|
|||
<li><a class="reference external"
|
||||
data-doc-search-tag="paths: testsIncludeDir(): string" href="paths.html#testsIncludeDir">paths: testsIncludeDir(): string</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="time64_t" href="#time64_t"><span>time64_t:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="types: time64_t" href="types.html#time64_t">types: time64_t</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="time_t" href="#time_t"><span>time_t:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="types: time_t" href="types.html#time_t">types: time_t</a></li>
|
||||
|
|
@ -1079,7 +1061,7 @@ function main() {
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small>Made with Nim. Generated: 2019-10-04 01:43:50 UTC</small>
|
||||
<small>Made with Nim. Generated: 2019-10-10 23:38:17 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
11
types.html
11
types.html
|
|
@ -828,6 +828,8 @@ function main() {
|
|||
<ul class="simple simple-toc-section">
|
||||
<li><a class="reference" href="#time_t"
|
||||
title="time_t = time_t_temp.Time"><wbr />time_<wbr />t<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#time64_t"
|
||||
title="time64_t = time_t_temp.Time"><wbr />time64_<wbr />t<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#wchar_t"
|
||||
title="wchar_t {.importc, header: "<cwchar>".} = object"><wbr />wchar_<wbr />t<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#ptrdiff_t"
|
||||
|
|
@ -864,6 +866,13 @@ function main() {
|
|||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="time64_t"></a>
|
||||
<dt><pre><a href="types.html#time64_t"><span class="Identifier">time64_t</span></a> <span class="Other">=</span> <span class="Identifier">time_t_temp</span><span class="Other">.</span><span class="Identifier">Time</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="wchar_t"></a>
|
||||
<dt><pre><a href="types.html#wchar_t"><span class="Identifier">wchar_t</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">"<cwchar>"</span></span><span class="Other">.}</span></span> <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
|
||||
|
|
@ -915,7 +924,7 @@ function main() {
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small>Made with Nim. Generated: 2019-10-04 01:43:48 UTC</small>
|
||||
<small>Made with Nim. Generated: 2019-10-10 23:38:15 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -1,4 +1,5 @@
|
|||
time_t types.html#time_t types: time_t
|
||||
time64_t types.html#time64_t types: time64_t
|
||||
wchar_t types.html#wchar_t types: wchar_t
|
||||
ptrdiff_t types.html#ptrdiff_t types: ptrdiff_t
|
||||
va_list types.html#va_list types: va_list
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue