Update documentation
This commit is contained in:
Ganesh Viswanathan
parent
3736ea8083
commit
674f008fe8
4 changed files with 98 additions and 56 deletions
42
git.html
42
git.html
|
|
@ -16,7 +16,7 @@
|
|||
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
|
||||
|
||||
<!-- CSS -->
|
||||
<title>Module git</title>
|
||||
<title>git</title>
|
||||
<style type="text/css" >
|
||||
/*
|
||||
Stylesheet for use with Docutils/rst2html.
|
||||
|
|
@ -1199,7 +1199,7 @@ span.pragmawrap {
|
|||
|
||||
</style>
|
||||
|
||||
<script type="text/javascript" src="../dochack.js"></script>
|
||||
<script type="text/javascript" src="dochack.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
function main() {
|
||||
|
|
@ -1219,7 +1219,7 @@ function main() {
|
|||
<body onload="main()">
|
||||
<div class="document" id="documentId">
|
||||
<div class="container">
|
||||
<h1 class="title">Module git</h1>
|
||||
<h1 class="title">git</h1>
|
||||
<div class="row">
|
||||
<div class="three columns">
|
||||
<div id="global-links">
|
||||
|
|
@ -1241,7 +1241,7 @@ function main() {
|
|||
<li>
|
||||
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<li><a class="reference" href="#execAction,string"
|
||||
<li><a class="reference" href="#execAction%2Cstring"
|
||||
title="execAction(cmd: string; nostderr = false): string"><wbr />exec<wbr />Action<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
|
||||
</ul>
|
||||
|
|
@ -1249,15 +1249,15 @@ function main() {
|
|||
<li>
|
||||
<a class="reference reference-toplevel" href="#17" id="67">Macros</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<li><a class="reference" href="#extractZip.m,,"
|
||||
<li><a class="reference" href="#extractZip.m%2C%2C"
|
||||
title="extractZip(zipfile, outdir: static string): untyped"><wbr />extract<wbr />Zip<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#downloadUrl.m,,"
|
||||
<li><a class="reference" href="#downloadUrl.m%2C%2C"
|
||||
title="downloadUrl(url, outdir: static string): untyped"><wbr />download<wbr />Url<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#gitReset.m,"
|
||||
<li><a class="reference" href="#gitReset.m%2C"
|
||||
title="gitReset(outdir: static string): untyped"><wbr />git<wbr />Reset<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#gitCheckout.m,,"
|
||||
<li><a class="reference" href="#gitCheckout.m%2C%2C"
|
||||
title="gitCheckout(file, outdir: static string): untyped"><wbr />git<wbr />Checkout<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#gitPull.m,,string,string,string"
|
||||
<li><a class="reference" href="#gitPull.m%2C%2Cstring%2Cstring%2Cstring"
|
||||
title="gitPull(url: static string; outdirN = ""; plistN = ""; checkoutN = ""): untyped"><wbr />git<wbr />Pull<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
|
||||
</ul>
|
||||
|
|
@ -1272,10 +1272,11 @@ function main() {
|
|||
<div class="section" id="12">
|
||||
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
||||
<dl class="item">
|
||||
<dt id="execAction"><a name="execAction,string"></a><pre><span class="Keyword">proc</span> <span class="Identifier">execAction</span><span class="Other">(</span><span class="Identifier">cmd</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">nostderr</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">OSError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span>
|
||||
<a id="execAction,string"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <span class="Identifier">execAction</span><span class="Other">(</span><span class="Identifier">cmd</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">nostderr</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">OSError</span><span class="Other">,</span> <span class="Identifier">Exception</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>
|
||||
unequals operator. This is a shorthand for <tt class="docutils literal"><span class="pre">not (x == y)</span></tt>.
|
||||
|
||||
|
||||
</dd>
|
||||
|
||||
|
|
@ -1283,29 +1284,34 @@ unequals operator. This is a shorthand for <tt class="docutils literal"><span cl
|
|||
<div class="section" id="17">
|
||||
<h1><a class="toc-backref" href="#17">Macros</a></h1>
|
||||
<dl class="item">
|
||||
<dt id="extractZip"><a name="extractZip.m,,"></a><pre><span class="Keyword">macro</span> <span class="Identifier">extractZip</span><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">static</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
|
||||
<a id="extractZip.m,,"></a>
|
||||
<dt><pre><span class="Keyword">macro</span> <span class="Identifier">extractZip</span><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">static</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
</dd>
|
||||
<dt id="downloadUrl"><a name="downloadUrl.m,,"></a><pre><span class="Keyword">macro</span> <span class="Identifier">downloadUrl</span><span class="Other">(</span><span class="Identifier">url</span><span class="Other">,</span> <span class="Identifier">outdir</span><span class="Other">:</span> <span class="Identifier">static</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
|
||||
<a id="downloadUrl.m,,"></a>
|
||||
<dt><pre><span class="Keyword">macro</span> <span class="Identifier">downloadUrl</span><span class="Other">(</span><span class="Identifier">url</span><span class="Other">,</span> <span class="Identifier">outdir</span><span class="Other">:</span> <span class="Identifier">static</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
</dd>
|
||||
<dt id="gitReset"><a name="gitReset.m,"></a><pre><span class="Keyword">macro</span> <span class="Identifier">gitReset</span><span class="Other">(</span><span class="Identifier">outdir</span><span class="Other">:</span> <span class="Identifier">static</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
|
||||
<a id="gitReset.m,"></a>
|
||||
<dt><pre><span class="Keyword">macro</span> <span class="Identifier">gitReset</span><span class="Other">(</span><span class="Identifier">outdir</span><span class="Other">:</span> <span class="Identifier">static</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
</dd>
|
||||
<dt id="gitCheckout"><a name="gitCheckout.m,,"></a><pre><span class="Keyword">macro</span> <span class="Identifier">gitCheckout</span><span class="Other">(</span><span class="Identifier">file</span><span class="Other">,</span> <span class="Identifier">outdir</span><span class="Other">:</span> <span class="Identifier">static</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
|
||||
<a id="gitCheckout.m,,"></a>
|
||||
<dt><pre><span class="Keyword">macro</span> <span class="Identifier">gitCheckout</span><span class="Other">(</span><span class="Identifier">file</span><span class="Other">,</span> <span class="Identifier">outdir</span><span class="Other">:</span> <span class="Identifier">static</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
</dd>
|
||||
<dt id="gitPull"><a name="gitPull.m,,string,string,string"></a><pre><span class="Keyword">macro</span> <span class="Identifier">gitPull</span><span class="Other">(</span><span class="Identifier">url</span><span class="Other">:</span> <span class="Identifier">static</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">outdirN</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">;</span> <span class="Identifier">plistN</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">;</span> <span class="Identifier">checkoutN</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
|
||||
<a id="gitPull.m,,string,string,string"></a>
|
||||
<dt><pre><span class="Keyword">macro</span> <span class="Identifier">gitPull</span><span class="Other">(</span><span class="Identifier">url</span><span class="Other">:</span> <span class="Identifier">static</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">outdirN</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">;</span> <span class="Identifier">plistN</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">;</span> <span class="Identifier">checkoutN</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
|
||||
<dd>
|
||||
unequals operator. This is a shorthand for <tt class="docutils literal"><span class="pre">not (x == y)</span></tt>.
|
||||
|
||||
|
||||
</dd>
|
||||
|
||||
|
|
@ -1318,7 +1324,7 @@ unequals operator. This is a shorthand for <tt class="docutils literal"><span cl
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small>Made with Nim. Generated: 2019-01-21 17:06:39 UTC</small>
|
||||
<small>Made with Nim. Generated: 2019-01-24 01:58:21 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue