diff options
Diffstat (limited to 'docs/modules/OID_Shorten.html')
| -rw-r--r-- | docs/modules/OID_Shorten.html | 251 |
1 files changed, 251 insertions, 0 deletions
diff --git a/docs/modules/OID_Shorten.html b/docs/modules/OID_Shorten.html new file mode 100644 index 0000000..07467a7 --- /dev/null +++ b/docs/modules/OID_Shorten.html @@ -0,0 +1,251 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html> +<head> + <title>Reference</title> + <link rel="stylesheet" href="../luadoc.css" type="text/css" /> + <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/--> +</head> + +<body> +<div id="container"> + +<div id="product"> + <div id="product_logo"></div> + <div id="product_name"><big><b></b></big></div> + <div id="product_description"></div> +</div> <!-- id="product" --> + +<div id="main"> + +<div id="navigation"> + + +<h1>LuaDoc</h1> +<ul> + + <li><a href="../index.html">Index</a></li> + +</ul> + + +<!-- Module list --> + +<h1>Modules</h1> +<ul> + + <li> + <a href="../modules/Blob.html">Blob</a> + </li> + + <li> + <a href="../modules/Commit.html">Commit</a> + </li> + + <li> + <a href="../modules/Config.html">Config</a> + </li> + + <li> + <a href="../modules/Index.html">Index</a> + </li> + + <li> + <a href="../modules/IndexEntry.html">IndexEntry</a> + </li> + + <li> + <a href="../modules/IndexEntryUnmerged.html">IndexEntryUnmerged</a> + </li> + + <li> + <a href="../modules/ODB.html">ODB</a> + </li> + + <li> + <a href="../modules/ODBBackend.html">ODBBackend</a> + </li> + + <li> + <a href="../modules/OID.html">OID</a> + </li> + + <li><strong>OID_Shorten</strong></li> + + <li> + <a href="../modules/Object.html">Object</a> + </li> + + <li> + <a href="../modules/OdbObject.html">OdbObject</a> + </li> + + <li> + <a href="../modules/Reference.html">Reference</a> + </li> + + <li> + <a href="../modules/Repository.html">Repository</a> + </li> + + <li> + <a href="../modules/RevWalk.html">RevWalk</a> + </li> + + <li> + <a href="../modules/Signature.html">Signature</a> + </li> + + <li> + <a href="../modules/StrArray.html">StrArray</a> + </li> + + <li> + <a href="../modules/Tag.html">Tag</a> + </li> + + <li> + <a href="../modules/Tree.html">Tree</a> + </li> + + <li> + <a href="../modules/TreeEntry.html">TreeEntry</a> + </li> + + <li> + <a href="../modules/git2.html">git2</a> + </li> + +</ul> + + + +<!-- File list --> + + + + + + +</div><!-- id="navigation" --> + +<div id="content"> + +<h1>Module <code>OID_Shorten</code></h1> + +<p>Class "OID_Shorten". </p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#OID_Shorten.new">OID_Shorten.new</a> (min_length)</td> + <td class="summary">Create a new OID_Shorten object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#OID_Shorten:add">OID_Shorten:add</a> (text_oid)</td> + <td class="summary">object method.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="OID_Shorten.new"></a><strong>OID_Shorten.new</strong> (min_length)</dt> +<dd> +Create a new OID_Shorten object. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/oid/git_oid_shorten_new">git_oid_shorten_new</a>:<p><p>The OID shortener is used to process a list of OIDs in text form and return the shortest length that would uniquely identify all of them.<p> E.g. look at the result of `git log --abbrev`. + + +<h3>Parameters</h3> +<ul> + + <li> + min_length: The minimal length for all identifiers, which will be used even if shorter OIDs would still be unique.. Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return value:</h3> +<a href="OID_Shorten.html">OID_Shorten</a>. + + + +</dd> + + + + +<dt><a name="OID_Shorten:add"></a><strong>OID_Shorten:add</strong> (text_oid)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/oid/git_oid_shorten_add">git_oid_shorten_add</a>:<p><p>The OID is expected to be a 40-char hexadecimal string. The OID is owned by the user and will not be modified or freed.<p> For performance reasons, there is a hard-limit of how many OIDs can be added to a single set (around ~22000, assuming a mostly randomized distribution), which should be enough for any kind of program, and keeps the algorithm fast and memory-efficient.<p> Attempting to add more than those OIDs will result in a GIT_ENOMEM error + + +<h3>Parameters</h3> +<ul> + + <li> + text_oid: an OID in text form. Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + +</dl> + + + + + + +</div> <!-- id="content" --> + +</div> <!-- id="main" --> + +<div id="about"> + <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p> +</div> <!-- id="about" --> + +</div> <!-- id="container" --> +</body> +</html> |