diff options
Diffstat (limited to 'docs/modules')
| -rw-r--r-- | docs/modules/Blob.html | 456 | ||||
| -rw-r--r-- | docs/modules/Commit.html | 661 | ||||
| -rw-r--r-- | docs/modules/Config.html | 690 | ||||
| -rw-r--r-- | docs/modules/Index.html | 757 | ||||
| -rw-r--r-- | docs/modules/IndexEntry.html | 640 | ||||
| -rw-r--r-- | docs/modules/IndexEntryUnmerged.html | 270 | ||||
| -rw-r--r-- | docs/modules/ODB.html | 656 | ||||
| -rw-r--r-- | docs/modules/ODBBackend.html | 202 | ||||
| -rw-r--r-- | docs/modules/OID.html | 360 | ||||
| -rw-r--r-- | docs/modules/OID_Shorten.html | 251 | ||||
| -rw-r--r-- | docs/modules/Object.html | 342 | ||||
| -rw-r--r-- | docs/modules/OdbObject.html | 299 | ||||
| -rw-r--r-- | docs/modules/Reference.html | 616 | ||||
| -rw-r--r-- | docs/modules/Repository.html | 668 | ||||
| -rw-r--r-- | docs/modules/RevWalk.html | 428 | ||||
| -rw-r--r-- | docs/modules/Signature.html | 354 | ||||
| -rw-r--r-- | docs/modules/StrArray.html | 308 | ||||
| -rw-r--r-- | docs/modules/Tag.html | 424 | ||||
| -rw-r--r-- | docs/modules/Tree.html | 411 | ||||
| -rw-r--r-- | docs/modules/TreeEntry.html | 296 | ||||
| -rw-r--r-- | docs/modules/git2.html | 202 |
21 files changed, 9291 insertions, 0 deletions
diff --git a/docs/modules/Blob.html b/docs/modules/Blob.html new file mode 100644 index 0000000..5e01c97 --- /dev/null +++ b/docs/modules/Blob.html @@ -0,0 +1,456 @@ +<!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><strong>Blob</strong></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> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </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>Blob</code></h1> + +<p>Class "Blob". Extends <a href="Object.html">Object</a><br /></p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#Blob.frombuffer">Blob.frombuffer</a> (repo, buffer)</td> + <td class="summary">module function.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Blob.fromfile">Blob.fromfile</a> (repo, path)</td> + <td class="summary">module function.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Blob.lookup">Blob.lookup</a> (repo, id)</td> + <td class="summary">Create a new Blob object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Blob:rawcontent">Blob:rawcontent</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Blob:rawsize">Blob:rawsize</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:free">Object:free</a> ()</td> + <td class="summary">Destroy this object (will be called by Garbage Collector).</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:id">Object:id</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:owner">Object:owner</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:type">Object:type</a> ()</td> + <td class="summary">object method.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="Blob.frombuffer"></a><strong>Blob.frombuffer</strong> (repo, buffer)</dt> +<dd> +module function. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_create_frombuffer">git_blob_create_frombuffer</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + repo: repository where to blob will be written. Must be of type <a href="Repository.html">Repository</a>. + </li> + + <li> + buffer: data to be written into the blob. Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="OID.html">OID</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Blob.fromfile"></a><strong>Blob.fromfile</strong> (repo, path)</dt> +<dd> +module function. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_create_fromfile">git_blob_create_fromfile</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + repo: repository where the blob will be written. this repository cannot be bare. Must be of type <a href="Repository.html">Repository</a>. + </li> + + <li> + path: file from which the blob will be created, relative to the repository's working dir. Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="OID.html">OID</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Blob.lookup"></a><strong>Blob.lookup</strong> (repo, id)</dt> +<dd> +Create a new Blob object. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_lookup">git_blob_lookup</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + repo: the repo to use when locating the blob.. Must be of type <a href="Repository.html">Repository</a>. + </li> + + <li> + id: identity of the blob to locate.. Must be of type <a href="OID.html">OID</a>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Blob.html">Blob</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Blob:rawcontent"></a><strong>Blob:rawcontent</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_rawcontent">git_blob_rawcontent</a>:<p><p>A pointer to the raw content of a blob is returned; this pointer is owned internally by the object and shall not be free'd. The pointer may be invalidated at a later time. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_rawsize">git_blob_rawsize</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</dd> + + + + +<dt><a name="Blob:rawsize"></a><strong>Blob:rawsize</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_rawsize">git_blob_rawsize</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="Object:free"></a><strong>Object:free</strong> ()</dt> +<dd> +Destroy this object (will be called by Garbage Collector). <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_free">git_object_free</a>:<p><p>This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.<p> IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. + + + + + + + + + +</dd> + + + + +<dt><a name="Object:id"></a><strong>Object:id</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_id">git_object_id</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<a href="OID.html">OID</a>. + + + +</dd> + + + + +<dt><a name="Object:owner"></a><strong>Object:owner</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_owner">git_object_owner</a>:<p><p>Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.<p> Any other operation may be run on the repository without affecting the object. + + + + + + + +<h3>Return value:</h3> +<a href="Repository.html">Repository</a>. + + + +</dd> + + + + +<dt><a name="Object:type"></a><strong>Object:type</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_type">git_object_type</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</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> diff --git a/docs/modules/Commit.html b/docs/modules/Commit.html new file mode 100644 index 0000000..ab884fb --- /dev/null +++ b/docs/modules/Commit.html @@ -0,0 +1,661 @@ +<!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><strong>Commit</strong></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> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </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>Commit</code></h1> + +<p>Class "Commit". Extends <a href="Object.html">Object</a><br /></p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#Commit.create">Commit.create</a> (oid, repo, update_ref, author, committer, message_encoding, message, tree, parent)</td> + <td class="summary">module function.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Commit.lookup">Commit.lookup</a> (repo, id)</td> + <td class="summary">Create a new Commit object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Commit:author">Commit:author</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Commit:committer">Commit:committer</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Commit:id">Commit:id</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Commit:message">Commit:message</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Commit:message_encoding">Commit:message_encoding</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Commit:parent">Commit:parent</a> (n)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Commit:parentcount">Commit:parentcount</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Commit:time">Commit:time</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Commit:time_offset">Commit:time_offset</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Commit:tree">Commit:tree</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:free">Object:free</a> ()</td> + <td class="summary">Destroy this object (will be called by Garbage Collector).</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:id">Object:id</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:owner">Object:owner</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:type">Object:type</a> ()</td> + <td class="summary">object method.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="Commit.create"></a><strong>Commit.create</strong> (oid, repo, update_ref, author, committer, message_encoding, message, tree, parent)</dt> +<dd> +module function. + + +<h3>Parameters</h3> +<ul> + + <li> + oid: Must be of type <a href="OID.html">OID</a>. + </li> + + <li> + repo: Must be of type <a href="Repository.html">Repository</a>. + </li> + + <li> + update_ref: Must be of type <code>string</code>. + </li> + + <li> + author: Must be of type <a href="Signature.html">Signature</a>. + </li> + + <li> + committer: Must be of type <a href="Signature.html">Signature</a>. + </li> + + <li> + message_encoding: Must be of type <code>string</code>. + </li> + + <li> + message: Must be of type <code>string</code>. + </li> + + <li> + tree: Must be of type <a href="Tree.html">Tree</a>. + </li> + + <li> + parent: Must be of type <a href="Commit.html">Commit</a>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Commit.lookup"></a><strong>Commit.lookup</strong> (repo, id)</dt> +<dd> +Create a new Commit object. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_lookup">git_commit_lookup</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + repo: the repo to use when locating the commit.. Must be of type <a href="Repository.html">Repository</a>. + </li> + + <li> + id: identity of the commit to locate. If the object is an annotated tag it will be peeled back to the commit.. Must be of type <a href="OID.html">OID</a>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Commit.html">Commit</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Commit:author"></a><strong>Commit:author</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_author">git_commit_author</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<a href="Signature.html">Signature</a>. + + + +</dd> + + + + +<dt><a name="Commit:committer"></a><strong>Commit:committer</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_committer">git_commit_committer</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<a href="Signature.html">Signature</a>. + + + +</dd> + + + + +<dt><a name="Commit:id"></a><strong>Commit:id</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_id">git_commit_id</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<a href="OID.html">OID</a>. + + + +</dd> + + + + +<dt><a name="Commit:message"></a><strong>Commit:message</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_message">git_commit_message</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</dd> + + + + +<dt><a name="Commit:message_encoding"></a><strong>Commit:message_encoding</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_message_encoding">git_commit_message_encoding</a>:<p><p>The encoding may be NULL if the `encoding` header in the commit is missing; in that case UTF-8 is assumed. + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</dd> + + + + +<dt><a name="Commit:parent"></a><strong>Commit:parent</strong> (n)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_parent">git_commit_parent</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + n: the position of the parent (from 0 to `parentcount`). Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Commit.html">Commit</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Commit:parentcount"></a><strong>Commit:parentcount</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_parentcount">git_commit_parentcount</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="Commit:time"></a><strong>Commit:time</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_time">git_commit_time</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="Commit:time_offset"></a><strong>Commit:time_offset</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_time_offset">git_commit_time_offset</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="Commit:tree"></a><strong>Commit:tree</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_tree">git_commit_tree</a>:<p><p> + + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Tree.html">Tree</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Object:free"></a><strong>Object:free</strong> ()</dt> +<dd> +Destroy this object (will be called by Garbage Collector). <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_free">git_object_free</a>:<p><p>This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.<p> IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. + + + + + + + + + +</dd> + + + + +<dt><a name="Object:id"></a><strong>Object:id</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_id">git_object_id</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<a href="OID.html">OID</a>. + + + +</dd> + + + + +<dt><a name="Object:owner"></a><strong>Object:owner</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_owner">git_object_owner</a>:<p><p>Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.<p> Any other operation may be run on the repository without affecting the object. + + + + + + + +<h3>Return value:</h3> +<a href="Repository.html">Repository</a>. + + + +</dd> + + + + +<dt><a name="Object:type"></a><strong>Object:type</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_type">git_object_type</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</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> diff --git a/docs/modules/Config.html b/docs/modules/Config.html new file mode 100644 index 0000000..213b179 --- /dev/null +++ b/docs/modules/Config.html @@ -0,0 +1,690 @@ +<!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><strong>Config</strong></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> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </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>Config</code></h1> + +<p>Class "Config". </p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#Config.new">Config.new</a> ()</td> + <td class="summary">Create a new Config object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Config.open">Config.open</a> (path)</td> + <td class="summary">Create a new Config object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Config:add_file_ondisk">Config:add_file_ondisk</a> (path, priority)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Config:delete">Config:delete</a> (name)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Config:free">Config:free</a> ()</td> + <td class="summary">Destroy this object (will be called by Garbage Collector).</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Config:get_bool">Config:get_bool</a> (name)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Config:get_int32">Config:get_int32</a> (name)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Config:get_int64">Config:get_int64</a> (name)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Config:get_string">Config:get_string</a> (name)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Config:set_bool">Config:set_bool</a> (value, name)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Config:set_int32">Config:set_int32</a> (name, value)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Config:set_int64">Config:set_int64</a> (name, value)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Config:set_string">Config:set_string</a> (name, value)</td> + <td class="summary">object method.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="Config.new"></a><strong>Config.new</strong> ()</dt> +<dd> +Create a new Config object. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/config/git_config_new">git_config_new</a>:<p><p>This object is empty, so you have to add a file to it before you can do anything with it. + + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Config.html">Config</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Config.open"></a><strong>Config.open</strong> (path)</dt> +<dd> +Create a new Config object. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/config/git_config_open_ondisk">git_config_open_ondisk</a>:<p><p>This method is a simple utility wrapper for the following sequence of calls: - git_config_new - git_config_add_file_ondisk + + +<h3>Parameters</h3> +<ul> + + <li> + path: Path to the on-disk file to open. Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Config.html">Config</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Config:add_file_ondisk"></a><strong>Config:add_file_ondisk</strong> (path, priority)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/config/git_config_add_file_ondisk">git_config_add_file_ondisk</a>:<p><p>The on-disk file pointed at by `path` will be opened and parsed; it's expected to be a native Git config file following the default Git config syntax (see man git-config).<p> Note that the configuration object will free the file automatically.<p> Further queries on this config object will access each of the config file instances in order (instances with a higher priority will be accessed first). + + +<h3>Parameters</h3> +<ul> + + <li> + path: path to the configuration file (backend) to add. Must be of type <code>string</code>. + </li> + + <li> + priority: the priority the backend should have. Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Config:delete"></a><strong>Config:delete</strong> (name)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/config/git_config_delete">git_config_delete</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + name: the variable to delete. 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> + + + + +<dt><a name="Config:free"></a><strong>Config:free</strong> ()</dt> +<dd> +Destroy this object (will be called by Garbage Collector). <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/config/git_config_free">git_config_free</a>:<p><p> + + + + + + + + + +</dd> + + + + +<dt><a name="Config:get_bool"></a><strong>Config:get_bool</strong> (name)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/config/git_config_get_bool">git_config_get_bool</a>:<p><p>This function uses the usual C convention of 0 being false and anything else true. + + +<h3>Parameters</h3> +<ul> + + <li> + name: the variable's name. Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>boolean</code> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Config:get_int32"></a><strong>Config:get_int32</strong> (name)</dt> +<dd> +object method. + + +<h3>Parameters</h3> +<ul> + + <li> + name: Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>integer</code> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Config:get_int64"></a><strong>Config:get_int64</strong> (name)</dt> +<dd> +object method. + + +<h3>Parameters</h3> +<ul> + + <li> + name: Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>integer</code> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Config:get_string"></a><strong>Config:get_string</strong> (name)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/config/git_config_get_string">git_config_get_string</a>:<p><p>The string is owned by the variable and should not be freed by the user. + + +<h3>Parameters</h3> +<ul> + + <li> + name: the variable's name. Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>string</code> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Config:set_bool"></a><strong>Config:set_bool</strong> (value, name)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/config/git_config_set_bool">git_config_set_bool</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + value: the value to store. Must be of type <code>boolean</code>. + </li> + + <li> + name: the variable's name. 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> + + + + +<dt><a name="Config:set_int32"></a><strong>Config:set_int32</strong> (name, value)</dt> +<dd> +object method. + + +<h3>Parameters</h3> +<ul> + + <li> + name: Must be of type <code>string</code>. + </li> + + <li> + value: Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Config:set_int64"></a><strong>Config:set_int64</strong> (name, value)</dt> +<dd> +object method. + + +<h3>Parameters</h3> +<ul> + + <li> + name: Must be of type <code>string</code>. + </li> + + <li> + value: Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Config:set_string"></a><strong>Config:set_string</strong> (name, value)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/config/git_config_set_string">git_config_set_string</a>:<p><p>A copy of the string is made and the user is free to use it afterwards. + + +<h3>Parameters</h3> +<ul> + + <li> + name: the variable's name. Must be of type <code>string</code>. + </li> + + <li> + value: the string to store.. 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> diff --git a/docs/modules/Index.html b/docs/modules/Index.html new file mode 100644 index 0000000..8857b39 --- /dev/null +++ b/docs/modules/Index.html @@ -0,0 +1,757 @@ +<!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><strong>Index</strong></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> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </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>Index</code></h1> + +<p>Class "Index". </p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#Index.bare">Index.bare</a> (index_path)</td> + <td class="summary">Create a new Index object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Index:add">Index:add</a> (path, stage)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Index:add2">Index:add2</a> (source_entry)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Index:append">Index:append</a> (path, stage)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Index:append2">Index:append2</a> (source_entry)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Index:clear">Index:clear</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Index:entrycount">Index:entrycount</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Index:entrycount_unmerged">Index:entrycount_unmerged</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Index:find">Index:find</a> (path)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Index:get">Index:get</a> (n)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Index:get_unmerged_byindex">Index:get_unmerged_byindex</a> (n)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Index:get_unmerged_bypath">Index:get_unmerged_bypath</a> (path)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Index:read">Index:read</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Index:read_tree">Index:read_tree</a> (tree)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Index:remove">Index:remove</a> (position)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Index:uniq">Index:uniq</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Index:write">Index:write</a> ()</td> + <td class="summary">object method.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="Index.bare"></a><strong>Index.bare</strong> (index_path)</dt> +<dd> +Create a new Index object. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_open">git_index_open</a>:<p><p>Since there is no ODB or working directory behind this index, any Index methods which rely on these (e.g. index_add) will fail with the GIT_EBAREINDEX error code.<p> If you need to access the index of an actual repository, use the `git_repository_index` wrapper.<p> The index must be freed once it's no longer in use. + + +<h3>Parameters</h3> +<ul> + + <li> + index_path: the path to the index file in disk. Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Index.html">Index</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Index:add"></a><strong>Index:add</strong> (path, stage)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_add">git_index_add</a>:<p><p>The file `path` must be relative to the repository's working folder and must be readable.<p> This method will fail in bare index instances.<p> This forces the file to be added to the index, not looking at gitignore rules. Those rules can be evaluated through the git_status APIs (in status.h) before calling this. + + +<h3>Parameters</h3> +<ul> + + <li> + path: filename to add. Must be of type <code>string</code>. + </li> + + <li> + stage: stage for the entry. Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Index:add2"></a><strong>Index:add2</strong> (source_entry)</dt> +<dd> +object method. + + +<h3>Parameters</h3> +<ul> + + <li> + source_entry: Must be of type <a href="IndexEntry.html">IndexEntry</a>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Index:append"></a><strong>Index:append</strong> (path, stage)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_append">git_index_append</a>:<p><p>A new entry will always be inserted into the index; if the index already contains an entry for such path, the old entry will **not** be replaced.<p> The file `path` must be relative to the repository's working folder and must be readable.<p> This method will fail in bare index instances. + + +<h3>Parameters</h3> +<ul> + + <li> + path: filename to add. Must be of type <code>string</code>. + </li> + + <li> + stage: stage for the entry. Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Index:append2"></a><strong>Index:append2</strong> (source_entry)</dt> +<dd> +object method. + + +<h3>Parameters</h3> +<ul> + + <li> + source_entry: Must be of type <a href="IndexEntry.html">IndexEntry</a>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Index:clear"></a><strong>Index:clear</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_clear">git_index_clear</a>:<p><p> + + + + + + + + + +</dd> + + + + +<dt><a name="Index:entrycount"></a><strong>Index:entrycount</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_entrycount">git_index_entrycount</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="Index:entrycount_unmerged"></a><strong>Index:entrycount_unmerged</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_entrycount_unmerged">git_index_entrycount_unmerged</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="Index:find"></a><strong>Index:find</strong> (path)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_find">git_index_find</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + path: path to search. Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="Index:get"></a><strong>Index:get</strong> (n)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_get">git_index_get</a>:<p><p>This entry can be modified, and the changes will be written back to disk on the next write() call.<p> The entry should not be freed by the caller. + + +<h3>Parameters</h3> +<ul> + + <li> + n: the position of the entry. Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return value:</h3> +<a href="IndexEntry.html">IndexEntry</a>. + + + +</dd> + + + + +<dt><a name="Index:get_unmerged_byindex"></a><strong>Index:get_unmerged_byindex</strong> (n)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_get_unmerged_byindex">git_index_get_unmerged_byindex</a>:<p><p>The returned entry is read-only and should not be modified of freed by the caller. + + +<h3>Parameters</h3> +<ul> + + <li> + n: the position of the entry. Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return value:</h3> +<a href="IndexEntryUnmerged.html">IndexEntryUnmerged</a>. + + + +</dd> + + + + +<dt><a name="Index:get_unmerged_bypath"></a><strong>Index:get_unmerged_bypath</strong> (path)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_get_unmerged_bypath">git_index_get_unmerged_bypath</a>:<p><p>The returned entry is read-only and should not be modified of freed by the caller. + + +<h3>Parameters</h3> +<ul> + + <li> + path: path to search. Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return value:</h3> +<a href="IndexEntryUnmerged.html">IndexEntryUnmerged</a>. + + + +</dd> + + + + +<dt><a name="Index:read"></a><strong>Index:read</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_read">git_index_read</a>:<p><p> + + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Index:read_tree"></a><strong>Index:read_tree</strong> (tree)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_read_tree">git_index_read_tree</a>:<p><p>The current index contents will be replaced by the specified tree. + + +<h3>Parameters</h3> +<ul> + + <li> + tree: tree to read. Must be of type <a href="Tree.html">Tree</a>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Index:remove"></a><strong>Index:remove</strong> (position)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_remove">git_index_remove</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + position: position of the entry to remove. Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Index:uniq"></a><strong>Index:uniq</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_uniq">git_index_uniq</a>:<p><p> + + + + + + + + + +</dd> + + + + +<dt><a name="Index:write"></a><strong>Index:write</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_write">git_index_write</a>:<p><p> + + + + + + + +<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> diff --git a/docs/modules/IndexEntry.html b/docs/modules/IndexEntry.html new file mode 100644 index 0000000..4ff440e --- /dev/null +++ b/docs/modules/IndexEntry.html @@ -0,0 +1,640 @@ +<!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><strong>IndexEntry</strong></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> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </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>IndexEntry</code></h1> + +<p>Class "IndexEntry". </p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#IndexEntry.new">IndexEntry.new</a> ()</td> + <td class="summary">Create a new IndexEntry object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#IndexEntry:ctime">IndexEntry:ctime</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#IndexEntry:dev">IndexEntry:dev</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#IndexEntry:file_size">IndexEntry:file_size</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#IndexEntry:flags">IndexEntry:flags</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#IndexEntry:flags_extended">IndexEntry:flags_extended</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#IndexEntry:gid">IndexEntry:gid</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#IndexEntry:ino">IndexEntry:ino</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#IndexEntry:mode">IndexEntry:mode</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#IndexEntry:mtime">IndexEntry:mtime</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#IndexEntry:oid">IndexEntry:oid</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#IndexEntry:path">IndexEntry:path</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#IndexEntry:set_ctime">IndexEntry:set_ctime</a> (secs, nanosecs)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#IndexEntry:set_mtime">IndexEntry:set_mtime</a> (secs, nanosecs)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#IndexEntry:set_path">IndexEntry:set_path</a> (val)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#IndexEntry:stage">IndexEntry:stage</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#IndexEntry:uid">IndexEntry:uid</a> ()</td> + <td class="summary">object method.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="IndexEntry.new"></a><strong>IndexEntry.new</strong> ()</dt> +<dd> +Create a new IndexEntry object. + + + + + + + +<h3>Return value:</h3> +<a href="IndexEntry.html">IndexEntry</a>. + + + +</dd> + + + + +<dt><a name="IndexEntry:ctime"></a><strong>IndexEntry:ctime</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>integer</code>. + + <li><code>integer</code>. + +</ol> + + + +</dd> + + + + +<dt><a name="IndexEntry:dev"></a><strong>IndexEntry:dev</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="IndexEntry:file_size"></a><strong>IndexEntry:file_size</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="IndexEntry:flags"></a><strong>IndexEntry:flags</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="IndexEntry:flags_extended"></a><strong>IndexEntry:flags_extended</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="IndexEntry:gid"></a><strong>IndexEntry:gid</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="IndexEntry:ino"></a><strong>IndexEntry:ino</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="IndexEntry:mode"></a><strong>IndexEntry:mode</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="IndexEntry:mtime"></a><strong>IndexEntry:mtime</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>integer</code>. + + <li><code>integer</code>. + +</ol> + + + +</dd> + + + + +<dt><a name="IndexEntry:oid"></a><strong>IndexEntry:oid</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return value:</h3> +<a href="OID.html">OID</a>. + + + +</dd> + + + + +<dt><a name="IndexEntry:path"></a><strong>IndexEntry:path</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</dd> + + + + +<dt><a name="IndexEntry:set_ctime"></a><strong>IndexEntry:set_ctime</strong> (secs, nanosecs)</dt> +<dd> +object method. + + +<h3>Parameters</h3> +<ul> + + <li> + secs: Must be of type <code>integer</code>. + </li> + + <li> + nanosecs: Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + + + +</dd> + + + + +<dt><a name="IndexEntry:set_mtime"></a><strong>IndexEntry:set_mtime</strong> (secs, nanosecs)</dt> +<dd> +object method. + + +<h3>Parameters</h3> +<ul> + + <li> + secs: Must be of type <code>integer</code>. + </li> + + <li> + nanosecs: Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + + + +</dd> + + + + +<dt><a name="IndexEntry:set_path"></a><strong>IndexEntry:set_path</strong> (val)</dt> +<dd> +object method. + + +<h3>Parameters</h3> +<ul> + + <li> + val: Must be of type <code>string</code>. + </li> + +</ul> + + + + + + + + +</dd> + + + + +<dt><a name="IndexEntry:stage"></a><strong>IndexEntry:stage</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/index/git_index_entry_stage">git_index_entry_stage</a>:<p><p>This entry is calculated from the entrie's flag + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="IndexEntry:uid"></a><strong>IndexEntry:uid</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</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> diff --git a/docs/modules/IndexEntryUnmerged.html b/docs/modules/IndexEntryUnmerged.html new file mode 100644 index 0000000..e8e5b22 --- /dev/null +++ b/docs/modules/IndexEntryUnmerged.html @@ -0,0 +1,270 @@ +<!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><strong>IndexEntryUnmerged</strong></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> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </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>IndexEntryUnmerged</code></h1> + +<p>Class "IndexEntryUnmerged". </p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#IndexEntryUnmerged:mode">IndexEntryUnmerged:mode</a> (idx)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#IndexEntryUnmerged:oid">IndexEntryUnmerged:oid</a> (idx)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#IndexEntryUnmerged:path">IndexEntryUnmerged:path</a> ()</td> + <td class="summary">object method.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="IndexEntryUnmerged:mode"></a><strong>IndexEntryUnmerged:mode</strong> (idx)</dt> +<dd> +object method. + + +<h3>Parameters</h3> +<ul> + + <li> + idx: Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="IndexEntryUnmerged:oid"></a><strong>IndexEntryUnmerged:oid</strong> (idx)</dt> +<dd> +object method. + + +<h3>Parameters</h3> +<ul> + + <li> + idx: Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return value:</h3> +<a href="OID.html">OID</a>. + + + +</dd> + + + + +<dt><a name="IndexEntryUnmerged:path"></a><strong>IndexEntryUnmerged:path</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</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> diff --git a/docs/modules/ODB.html b/docs/modules/ODB.html new file mode 100644 index 0000000..1076315 --- /dev/null +++ b/docs/modules/ODB.html @@ -0,0 +1,656 @@ +<!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><strong>ODB</strong></li> + + <li> + <a href="../modules/ODBBackend.html">ODBBackend</a> + </li> + + <li> + <a href="../modules/OID.html">OID</a> + </li> + + <li> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </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>ODB</code></h1> + +<p>Class "ODB". </p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#ODB.hash">ODB.hash</a> (data, otype)</td> + <td class="summary">module function.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#ODB.hashfile">ODB.hashfile</a> (path, otype)</td> + <td class="summary">module function.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#ODB.new">ODB.new</a> ()</td> + <td class="summary">Create a new ODB object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#ODB.open">ODB.open</a> (object_dir)</td> + <td class="summary">Create a new ODB object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#ODB:add_alternate">ODB:add_alternate</a> (backend, priority)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#ODB:add_backend">ODB:add_backend</a> (backend, priority)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#ODB:exists">ODB:exists</a> (id)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#ODB:free">ODB:free</a> ()</td> + <td class="summary">Destroy this object (will be called by Garbage Collector).</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#ODB:read">ODB:read</a> (id)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#ODB:read_header">ODB:read_header</a> (id)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#ODB:read_prefix">ODB:read_prefix</a> (short_id, len)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#ODB:write">ODB:write</a> (data, type)</td> + <td class="summary">object method.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="ODB.hash"></a><strong>ODB.hash</strong> (data, otype)</dt> +<dd> +module function. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_hash">git_odb_hash</a>:<p><p>The resulting SHA-1 OID will the itentifier for the data buffer as if the data buffer it were to written to the ODB. + + +<h3>Parameters</h3> +<ul> + + <li> + data: data to hash. Must be of type <code>string</code>. + </li> + + <li> + otype: Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="OID.html">OID</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="ODB.hashfile"></a><strong>ODB.hashfile</strong> (path, otype)</dt> +<dd> +module function. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_hashfile">git_odb_hashfile</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + path: file to read and determine object id for. Must be of type <code>string</code>. + </li> + + <li> + otype: Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="OID.html">OID</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="ODB.new"></a><strong>ODB.new</strong> ()</dt> +<dd> +Create a new ODB object. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_new">git_odb_new</a>:<p><p>Before the ODB can be used for read/writing, a custom database backend must be manually added using `git_odb_add_backend()` + + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="ODB.html">ODB</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="ODB.open"></a><strong>ODB.open</strong> (object_dir)</dt> +<dd> +Create a new ODB object. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_open">git_odb_open</a>:<p><p>- git_odb_backend_loose: read and write loose object files from disk, assuming `objects_dir` as the Objects folder<p> - git_odb_backend_pack: read objects from packfiles, assuming `objects_dir` as the Objects folder which contains a 'pack/' folder with the corresponding data + + +<h3>Parameters</h3> +<ul> + + <li> + object_dir: Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="ODB.html">ODB</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="ODB:add_alternate"></a><strong>ODB:add_alternate</strong> (backend, priority)</dt> +<dd> +object method. + + +<h3>Parameters</h3> +<ul> + + <li> + backend: Must be of type <a href="ODBBackend.html">ODBBackend</a>. + </li> + + <li> + priority: Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="ODB:add_backend"></a><strong>ODB:add_backend</strong> (backend, priority)</dt> +<dd> +object method. + + +<h3>Parameters</h3> +<ul> + + <li> + backend: Must be of type <a href="ODBBackend.html">ODBBackend</a>. + </li> + + <li> + priority: Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="ODB:exists"></a><strong>ODB:exists</strong> (id)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_exists">git_odb_exists</a>:<p><p>@return - 1, if the object was found - 0, otherwise + + +<h3>Parameters</h3> +<ul> + + <li> + id: the object to search for.. Must be of type <a href="OID.html">OID</a>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="ODB:free"></a><strong>ODB:free</strong> ()</dt> +<dd> +Destroy this object (will be called by Garbage Collector). <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_free">git_odb_free</a>:<p><p> + + + + + + + + + +</dd> + + + + +<dt><a name="ODB:read"></a><strong>ODB:read</strong> (id)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_read">git_odb_read</a>:<p><p>This method queries all available ODB backends trying to read the given OID.<p> The returned object is reference counted and internally cached, so it should be closed by the user once it's no longer in use.<p> @return - 0 if the object was read; - GIT_ENOTFOUND if the object is not in the database. + + +<h3>Parameters</h3> +<ul> + + <li> + id: identity of the object to read.. Must be of type <a href="OID.html">OID</a>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="OdbObject.html">OdbObject</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="ODB:read_header"></a><strong>ODB:read_header</strong> (id)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_read_header">git_odb_read_header</a>:<p><p>The header includes the length and the type of an object.<p> Note that most backends do not support reading only the header of an object, so the whole object will be read and then the header will be returned.<p> @return - 0 if the object was read; - GIT_ENOTFOUND if the object is not in the database. + + +<h3>Parameters</h3> +<ul> + + <li> + id: identity of the object to read.. Must be of type <a href="OID.html">OID</a>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>integer</code> or <code>nil</code> on error. + + <li><code>string</code> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="ODB:read_prefix"></a><strong>ODB:read_prefix</strong> (short_id, len)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_read_prefix">git_odb_read_prefix</a>:<p><p>This method queries all available ODB backends trying to match the 'len' first hexadecimal characters of the 'short_id'. The remaining (GIT_OID_HEXSZ-len)*4 bits of 'short_id' must be 0s. 'len' must be at least GIT_OID_MINPREFIXLEN, and the prefix must be long enough to identify a unique object in all the backends; the method will fail otherwise.<p> The returned object is reference counted and internally cached, so it should be closed by the user once it's no longer in use. + + +<h3>Parameters</h3> +<ul> + + <li> + short_id: a prefix of the id of the object to read.. Must be of type <a href="OID.html">OID</a>. + </li> + + <li> + len: the length of the prefix. Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="OdbObject.html">OdbObject</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="ODB:write"></a><strong>ODB:write</strong> (data, type)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_write">git_odb_write</a>:<p><p>This method writes a full object straight into the ODB. For most cases, it is preferred to write objects through a write stream, which is both faster and less memory intensive, specially for big objects.<p> This method is provided for compatibility with custom backends which are not able to support streaming writes + + +<h3>Parameters</h3> +<ul> + + <li> + data: buffer with the data to storr. Must be of type <code>string</code>. + </li> + + <li> + type: type of the data to store. Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="OID.html">OID</a> or <code>nil</code> on 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> diff --git a/docs/modules/ODBBackend.html b/docs/modules/ODBBackend.html new file mode 100644 index 0000000..3d1dfbc --- /dev/null +++ b/docs/modules/ODBBackend.html @@ -0,0 +1,202 @@ +<!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><strong>ODBBackend</strong></li> + + <li> + <a href="../modules/OID.html">OID</a> + </li> + + <li> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </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>ODBBackend</code></h1> + +<p>Class "ODBBackend". </p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#ODBBackend.new">ODBBackend.new</a> ()</td> + <td class="summary">Create a new ODBBackend object.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="ODBBackend.new"></a><strong>ODBBackend.new</strong> ()</dt> +<dd> +Create a new ODBBackend object. + + + + + + + +<h3>Return value:</h3> +<a href="ODBBackend.html">ODBBackend</a>. + + + +</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> diff --git a/docs/modules/OID.html b/docs/modules/OID.html new file mode 100644 index 0000000..4e86584 --- /dev/null +++ b/docs/modules/OID.html @@ -0,0 +1,360 @@ +<!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><strong>OID</strong></li> + + <li> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </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</code></h1> + +<p>Class "OID". </p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#OID.hex">OID.hex</a> (str)</td> + <td class="summary">Create a new OID object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#OID.raw">OID.raw</a> (raw)</td> + <td class="summary">Create a new OID object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#OID:fmt">OID:fmt</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#OID:pathfmt">OID:pathfmt</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#OID_mt:__eq">OID_mt:__eq</a> (id)</td> + <td class="summary">object meta method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#OID_mt:__tostring">OID_mt:__tostring</a> ()</td> + <td class="summary">object meta method.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="OID.hex"></a><strong>OID.hex</strong> (str)</dt> +<dd> +Create a new OID object. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/oid/git_oid_fromstrn">git_oid_fromstrn</a>:<p><p>If N is odd, N-1 characters will be parsed instead. The remaining space in the git_oid will be set to zero. + + +<h3>Parameters</h3> +<ul> + + <li> + str: input hex string of at least size `length`. Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="OID.html">OID</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="OID.raw"></a><strong>OID.raw</strong> (raw)</dt> +<dd> +Create a new OID object. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/oid/git_oid_fromraw">git_oid_fromraw</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + raw: the raw input bytes to be copied.. Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return value:</h3> +<a href="OID.html">OID</a>. + + + +</dd> + + + + +<dt><a name="OID:fmt"></a><strong>OID:fmt</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</dd> + + + + +<dt><a name="OID:pathfmt"></a><strong>OID:pathfmt</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</dd> + + + + +<dt><a name="OID_mt:__eq"></a><strong>OID_mt:__eq</strong> (id)</dt> +<dd> +object meta method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/oid/git_oid_cmp">git_oid_cmp</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + id: Must be of type <a href="OID.html">OID</a>. + </li> + +</ul> + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="OID_mt:__tostring"></a><strong>OID_mt:__tostring</strong> ()</dt> +<dd> +object meta method. + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</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> 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> diff --git a/docs/modules/Object.html b/docs/modules/Object.html new file mode 100644 index 0000000..87ef26e --- /dev/null +++ b/docs/modules/Object.html @@ -0,0 +1,342 @@ +<!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> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </li> + + <li><strong>Object</strong></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>Object</code></h1> + +<p>Class "Object". </p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#Object.string2type">Object.string2type</a> (str)</td> + <td class="summary">module function.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object.type2string">Object.type2string</a> (otype)</td> + <td class="summary">module function.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:free">Object:free</a> ()</td> + <td class="summary">Destroy this object (will be called by Garbage Collector).</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:id">Object:id</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:owner">Object:owner</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:type">Object:type</a> ()</td> + <td class="summary">object method.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="Object.string2type"></a><strong>Object.string2type</strong> (str)</dt> +<dd> +module function. + + +<h3>Parameters</h3> +<ul> + + <li> + str: Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="Object.type2string"></a><strong>Object.type2string</strong> (otype)</dt> +<dd> +module function. + + +<h3>Parameters</h3> +<ul> + + <li> + otype: Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</dd> + + + + +<dt><a name="Object:free"></a><strong>Object:free</strong> ()</dt> +<dd> +Destroy this object (will be called by Garbage Collector). <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_free">git_object_free</a>:<p><p>This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.<p> IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. + + + + + + + + + +</dd> + + + + +<dt><a name="Object:id"></a><strong>Object:id</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_id">git_object_id</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<a href="OID.html">OID</a>. + + + +</dd> + + + + +<dt><a name="Object:owner"></a><strong>Object:owner</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_owner">git_object_owner</a>:<p><p>Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.<p> Any other operation may be run on the repository without affecting the object. + + + + + + + +<h3>Return value:</h3> +<a href="Repository.html">Repository</a>. + + + +</dd> + + + + +<dt><a name="Object:type"></a><strong>Object:type</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_type">git_object_type</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</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> diff --git a/docs/modules/OdbObject.html b/docs/modules/OdbObject.html new file mode 100644 index 0000000..971953a --- /dev/null +++ b/docs/modules/OdbObject.html @@ -0,0 +1,299 @@ +<!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> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </li> + + <li> + <a href="../modules/Object.html">Object</a> + </li> + + <li><strong>OdbObject</strong></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>OdbObject</code></h1> + +<p>Class "OdbObject". </p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#OdbObject:data">OdbObject:data</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#OdbObject:free">OdbObject:free</a> ()</td> + <td class="summary">Destroy this object (will be called by Garbage Collector).</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#OdbObject:id">OdbObject:id</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#OdbObject:size">OdbObject:size</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#OdbObject:type">OdbObject:type</a> ()</td> + <td class="summary">object method.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="OdbObject:data"></a><strong>OdbObject:data</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_object_data">git_odb_object_data</a>:<p><p>This is the uncompressed, raw data as read from the ODB, without the leading header.<p> This pointer is owned by the object and shall not be free'd. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_object_size">git_odb_object_size</a>:<p><p>This is the real size of the `data` buffer, not the actual size of the object. + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</dd> + + + + +<dt><a name="OdbObject:free"></a><strong>OdbObject:free</strong> ()</dt> +<dd> +Destroy this object (will be called by Garbage Collector). <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_object_free">git_odb_object_free</a>:<p><p>This method must always be called once a `git_odb_object` is no longer needed, otherwise memory will leak. + + + + + + + + + +</dd> + + + + +<dt><a name="OdbObject:id"></a><strong>OdbObject:id</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_object_id">git_odb_object_id</a>:<p><p>This is the OID from which the object was read from + + + + + + + +<h3>Return value:</h3> +<a href="OID.html">OID</a>. + + + +</dd> + + + + +<dt><a name="OdbObject:size"></a><strong>OdbObject:size</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_object_size">git_odb_object_size</a>:<p><p>This is the real size of the `data` buffer, not the actual size of the object. + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="OdbObject:type"></a><strong>OdbObject:type</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_object_type">git_odb_object_type</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</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> diff --git a/docs/modules/Reference.html b/docs/modules/Reference.html new file mode 100644 index 0000000..9e9bfc7 --- /dev/null +++ b/docs/modules/Reference.html @@ -0,0 +1,616 @@ +<!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> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </li> + + <li> + <a href="../modules/Object.html">Object</a> + </li> + + <li> + <a href="../modules/OdbObject.html">OdbObject</a> + </li> + + <li><strong>Reference</strong></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>Reference</code></h1> + +<p>Class "Reference". </p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#Reference.list">Reference.list</a> (repo, list_flags)</td> + <td class="summary">module function.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Reference.lookup">Reference.lookup</a> (repo, name)</td> + <td class="summary">Create a new Reference object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Reference.packall">Reference.packall</a> (repo)</td> + <td class="summary">module function.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Reference:delete">Reference:delete</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Reference:name">Reference:name</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Reference:oid">Reference:oid</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Reference:owner">Reference:owner</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Reference:rename">Reference:rename</a> (new_name, force)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Reference:resolve">Reference:resolve</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Reference:set_oid">Reference:set_oid</a> (oid)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Reference:set_target">Reference:set_target</a> (target)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Reference:target">Reference:target</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Reference:type">Reference:type</a> ()</td> + <td class="summary">object method.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="Reference.list"></a><strong>Reference.list</strong> (repo, list_flags)</dt> +<dd> +module function. + + +<h3>Parameters</h3> +<ul> + + <li> + repo: Must be of type <a href="Repository.html">Repository</a>. + </li> + + <li> + list_flags: Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="StrArray.html">StrArray</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Reference.lookup"></a><strong>Reference.lookup</strong> (repo, name)</dt> +<dd> +Create a new Reference object. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/reference/git_reference_lookup">git_reference_lookup</a>:<p><p>The generated reference must be freed by the user. + + +<h3>Parameters</h3> +<ul> + + <li> + repo: the repository to look up the reference. Must be of type <a href="Repository.html">Repository</a>. + </li> + + <li> + name: the long name for the reference (e.g. HEAD, ref/heads/master, refs/tags/v0.1.0, ...). Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Reference.html">Reference</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Reference.packall"></a><strong>Reference.packall</strong> (repo)</dt> +<dd> +module function. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/reference/git_reference_packall">git_reference_packall</a>:<p><p>This method will load into the cache all the loose references on the repository and update the `packed-refs` file with them.<p> Once the `packed-refs` file has been written properly, the loose references will be removed from disk. + + +<h3>Parameters</h3> +<ul> + + <li> + repo: Repository where the loose refs will be packed. Must be of type <a href="Repository.html">Repository</a>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Reference:delete"></a><strong>Reference:delete</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/reference/git_reference_delete">git_reference_delete</a>:<p><p>This method works for both direct and symbolic references.<p> The reference will be immediately removed on disk and from memory. The given reference pointer will no longer be valid. + + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Reference:name"></a><strong>Reference:name</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/reference/git_reference_name">git_reference_name</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</dd> + + + + +<dt><a name="Reference:oid"></a><strong>Reference:oid</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/reference/git_reference_oid">git_reference_oid</a>:<p><p>Only available if the reference is direct (i.e. not symbolic) + + + + + + + +<h3>Return value:</h3> +<a href="OID.html">OID</a>. + + + +</dd> + + + + +<dt><a name="Reference:owner"></a><strong>Reference:owner</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/reference/git_reference_owner">git_reference_owner</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<a href="Repository.html">Repository</a>. + + + +</dd> + + + + +<dt><a name="Reference:rename"></a><strong>Reference:rename</strong> (new_name, force)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/reference/git_reference_rename">git_reference_rename</a>:<p><p>This method works for both direct and symbolic references. The new name will be checked for validity and may be modified into a normalized form.<p> The given git_reference will be updated in place.<p> The reference will be immediately renamed in-memory and on disk.<p> If the `force` flag is not enabled, and there's already a reference with the given name, the renaming will fail.<p> IMPORTANT: The user needs to write a proper reflog entry if the reflog is enabled for the repository. We only rename the reflog if it exists. + + +<h3>Parameters</h3> +<ul> + + <li> + new_name: The new name for the reference. Must be of type <code>string</code>. + </li> + + <li> + force: Overwrite an existing reference. Must be of type <code>boolean</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Reference:resolve"></a><strong>Reference:resolve</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/reference/git_reference_resolve">git_reference_resolve</a>:<p><p>Thie method iteratively peels a symbolic reference until it resolves to a direct reference to an OID.<p> The peeled reference is returned in the `resolved_ref` argument, and must be freed manually once it's no longer needed.<p> If a direct reference is passed as an argument, a copy of that reference is returned. This copy must be manually freed too. + + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Reference.html">Reference</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Reference:set_oid"></a><strong>Reference:set_oid</strong> (oid)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/reference/git_reference_set_oid">git_reference_set_oid</a>:<p><p>The reference must be a direct reference, otherwise this method will fail.<p> The reference will be automatically updated in memory and on disk. + + +<h3>Parameters</h3> +<ul> + + <li> + oid: Must be of type <a href="OID.html">OID</a>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Reference:set_target"></a><strong>Reference:set_target</strong> (target)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/reference/git_reference_set_target">git_reference_set_target</a>:<p><p>The reference must be a symbolic reference, otherwise this method will fail.<p> The reference will be automatically updated in memory and on disk. + + +<h3>Parameters</h3> +<ul> + + <li> + target: The new target for the reference. 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> + + + + +<dt><a name="Reference:target"></a><strong>Reference:target</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/reference/git_reference_target">git_reference_target</a>:<p><p>Only available if the reference is symbolic + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</dd> + + + + +<dt><a name="Reference:type"></a><strong>Reference:type</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/reference/git_reference_type">git_reference_type</a>:<p><p>Either direct (GIT_REF_OID) or symbolic (GIT_REF_SYMBOLIC) + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</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> diff --git a/docs/modules/Repository.html b/docs/modules/Repository.html new file mode 100644 index 0000000..eb4d77f --- /dev/null +++ b/docs/modules/Repository.html @@ -0,0 +1,668 @@ +<!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> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </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><strong>Repository</strong></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>Repository</code></h1> + +<p>Class "Repository". </p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#Repository.init">Repository.init</a> (path, is_bare)</td> + <td class="summary">Create a new Repository object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Repository.open">Repository.open</a> (path)</td> + <td class="summary">Create a new Repository object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Repository:config">Repository:config</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Repository:head">Repository:head</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Repository:head_detached">Repository:head_detached</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Repository:head_orphan">Repository:head_orphan</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Repository:index">Repository:index</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Repository:is_bare">Repository:is_bare</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Repository:is_empty">Repository:is_empty</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Repository:odb">Repository:odb</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Repository:path">Repository:path</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Repository:set_config">Repository:set_config</a> (config)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Repository:set_index">Repository:set_index</a> (index)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Repository:set_odb">Repository:set_odb</a> (odb)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Repository:set_workdir">Repository:set_workdir</a> (workdir)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Repository:workdir">Repository:workdir</a> ()</td> + <td class="summary">object method.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="Repository.init"></a><strong>Repository.init</strong> (path, is_bare)</dt> +<dd> +Create a new Repository object. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/repository/git_repository_init">git_repository_init</a>:<p><p>TODO: - Reinit the repository + + +<h3>Parameters</h3> +<ul> + + <li> + path: the path to the repository. Must be of type <code>string</code>. + </li> + + <li> + is_bare: if true, a Git repository without a working directory is created at the pointed path. If false, provided path will be considered as the working directory into which the .git directory will be created.. Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Repository.html">Repository</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Repository.open"></a><strong>Repository.open</strong> (path)</dt> +<dd> +Create a new Repository object. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/repository/git_repository_open">git_repository_open</a>:<p><p>The 'path' argument must point to either a git repository folder, or an existing work dir.<p> The method will automatically detect if 'path' is a normal or bare repository or fail is 'path' is neither. + + +<h3>Parameters</h3> +<ul> + + <li> + path: the path to the repository. Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Repository.html">Repository</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Repository:config"></a><strong>Repository:config</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/repository/git_repository_config">git_repository_config</a>:<p><p>If a configuration file has not been set, the default config set for the repository will be returned, including global and system configurations (if they are available).<p> The configuration file must be freed once it's no longer being used by the user. + + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Config.html">Config</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Repository:head"></a><strong>Repository:head</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/repository/git_repository_head">git_repository_head</a>:<p><p> + + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Reference.html">Reference</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Repository:head_detached"></a><strong>Repository:head_detached</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/repository/git_repository_head_detached">git_repository_head_detached</a>:<p><p>A repository's HEAD is detached when it points directly to a commit instead of a branch. + + + + + + + +<h3>Return value:</h3> +<code>boolean</code>. + + + +</dd> + + + + +<dt><a name="Repository:head_orphan"></a><strong>Repository:head_orphan</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/repository/git_repository_head_orphan">git_repository_head_orphan</a>:<p><p>An orphan branch is one named from HEAD but which doesn't exist in the refs namespace, because it doesn't have any commit to point to. + + + + + + + +<h3>Return value:</h3> +<code>boolean</code>. + + + +</dd> + + + + +<dt><a name="Repository:index"></a><strong>Repository:index</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/repository/git_repository_index">git_repository_index</a>:<p><p>If a custom index has not been set, the default index for the repository will be returned (the one located in `.git/index`).<p> The index must be freed once it's no longer being used by the user. + + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Index.html">Index</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Repository:is_bare"></a><strong>Repository:is_bare</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/repository/git_repository_is_bare">git_repository_is_bare</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>boolean</code>. + + + +</dd> + + + + +<dt><a name="Repository:is_empty"></a><strong>Repository:is_empty</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/repository/git_repository_is_empty">git_repository_is_empty</a>:<p><p>An empty repository has just been initialized and contains no commits. + + + + + + + +<h3>Return value:</h3> +<code>boolean</code>. + + + +</dd> + + + + +<dt><a name="Repository:odb"></a><strong>Repository:odb</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/repository/git_repository_odb">git_repository_odb</a>:<p><p>If a custom ODB has not been set, the default database for the repository will be returned (the one located in `.git/objects`).<p> The ODB must be freed once it's no longer being used by the user. + + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="ODB.html">ODB</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Repository:path"></a><strong>Repository:path</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/repository/git_repository_path">git_repository_path</a>:<p><p>This is the path of the `.git` folder for normal repositories, or of the repository itself for bare repositories. + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</dd> + + + + +<dt><a name="Repository:set_config"></a><strong>Repository:set_config</strong> (config)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/repository/git_repository_set_config">git_repository_set_config</a>:<p><p>This configuration file will be used for all configuration queries involving this repository.<p> The repository will keep a reference to the config file; the user must still free the config after setting it to the repository, or it will leak. + + +<h3>Parameters</h3> +<ul> + + <li> + config: A Config object. Must be of type <a href="Config.html">Config</a>. + </li> + +</ul> + + + + + + + + +</dd> + + + + +<dt><a name="Repository:set_index"></a><strong>Repository:set_index</strong> (index)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/repository/git_repository_set_index">git_repository_set_index</a>:<p><p>This index will be used for all index-related operations involving this repository.<p> The repository will keep a reference to the index file; the user must still free the index after setting it to the repository, or it will leak. + + +<h3>Parameters</h3> +<ul> + + <li> + index: An index object. Must be of type <a href="Index.html">Index</a>. + </li> + +</ul> + + + + + + + + +</dd> + + + + +<dt><a name="Repository:set_odb"></a><strong>Repository:set_odb</strong> (odb)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/repository/git_repository_set_odb">git_repository_set_odb</a>:<p><p>The ODB will be used for all object-related operations involving this repository.<p> The repository will keep a reference to the ODB; the user must still free the ODB object after setting it to the repository, or it will leak. + + +<h3>Parameters</h3> +<ul> + + <li> + odb: An ODB object. Must be of type <a href="ODB.html">ODB</a>. + </li> + +</ul> + + + + + + + + +</dd> + + + + +<dt><a name="Repository:set_workdir"></a><strong>Repository:set_workdir</strong> (workdir)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/repository/git_repository_set_workdir">git_repository_set_workdir</a>:<p><p>The working directory doesn't need to be the same one that contains the `.git` folder for this repository.<p> If this repository is bare, setting its working directory will turn it into a normal repository, capable of performing all the common workdir operations (checkout, status, index manipulation, etc). + + +<h3>Parameters</h3> +<ul> + + <li> + workdir: The path to a working directory. 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> + + + + +<dt><a name="Repository:workdir"></a><strong>Repository:workdir</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/repository/git_repository_workdir">git_repository_workdir</a>:<p><p>If the repository is bare, this function will always return NULL. + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</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> diff --git a/docs/modules/RevWalk.html b/docs/modules/RevWalk.html new file mode 100644 index 0000000..6e99863 --- /dev/null +++ b/docs/modules/RevWalk.html @@ -0,0 +1,428 @@ +<!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> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </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><strong>RevWalk</strong></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>RevWalk</code></h1> + +<p>Class "RevWalk". </p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#RevWalk.new">RevWalk.new</a> (repo)</td> + <td class="summary">Create a new RevWalk object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#RevWalk:close">RevWalk:close</a> ()</td> + <td class="summary">Destroy this object (will be called by Garbage Collector).</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#RevWalk:hide">RevWalk:hide</a> (id)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#RevWalk:next">RevWalk:next</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#RevWalk:push">RevWalk:push</a> (id)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#RevWalk:repository">RevWalk:repository</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#RevWalk:reset">RevWalk:reset</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#RevWalk:sorting">RevWalk:sorting</a> (sort_mode)</td> + <td class="summary">object method.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="RevWalk.new"></a><strong>RevWalk.new</strong> (repo)</dt> +<dd> +Create a new RevWalk object. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/revwalk/git_revwalk_new">git_revwalk_new</a>:<p><p>This revision walker uses a custom memory pool and an internal commit cache, so it is relatively expensive to allocate.<p> For maximum performance, this revision walker should be reused for different walks.<p> This revision walker is *not* thread safe: it may only be used to walk a repository on a single thread; however, it is possible to have several revision walkers in several different threads walking the same repository. + + +<h3>Parameters</h3> +<ul> + + <li> + repo: the repo to walk through. Must be of type <a href="Repository.html">Repository</a>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="RevWalk.html">RevWalk</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="RevWalk:close"></a><strong>RevWalk:close</strong> ()</dt> +<dd> +Destroy this object (will be called by Garbage Collector). <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/revwalk/git_revwalk_free">git_revwalk_free</a>:<p><p> + + + + + + + + + +</dd> + + + + +<dt><a name="RevWalk:hide"></a><strong>RevWalk:hide</strong> (id)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/revwalk/git_revwalk_hide">git_revwalk_hide</a>:<p><p>The given OID must belong to a commit on the walked repository.<p> The resolved commit and all its parents will be hidden from the output on the revision walk. + + +<h3>Parameters</h3> +<ul> + + <li> + id: Must be of type <a href="OID.html">OID</a>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="RevWalk:next"></a><strong>RevWalk:next</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/revwalk/git_revwalk_next">git_revwalk_next</a>:<p><p>The initial call to this method is *not* blocking when iterating through a repo with a time-sorting mode.<p> Iterating with Topological or inverted modes makes the initial call blocking to preprocess the commit list, but this block should be mostly unnoticeable on most repositories (topological preprocessing times at 0.3s on the git.git repo).<p> The revision walker is reset when the walk is over. + + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="OID.html">OID</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="RevWalk:push"></a><strong>RevWalk:push</strong> (id)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/revwalk/git_revwalk_push">git_revwalk_push</a>:<p><p>The given OID must belong to a commit on the walked repository.<p> The given commit will be used as one of the roots when starting the revision walk. At least one commit must be pushed the repository before a walk can be started. + + +<h3>Parameters</h3> +<ul> + + <li> + id: Must be of type <a href="OID.html">OID</a>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>true</code> if no error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="RevWalk:repository"></a><strong>RevWalk:repository</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/revwalk/git_revwalk_repository">git_revwalk_repository</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<a href="Repository.html">Repository</a>. + + + +</dd> + + + + +<dt><a name="RevWalk:reset"></a><strong>RevWalk:reset</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/revwalk/git_revwalk_reset">git_revwalk_reset</a>:<p><p>This will clear all the pushed and hidden commits, and leave the walker in a blank state (just like at creation) ready to receive new commit pushes and start a new walk.<p> The revision walk is automatically reset when a walk is over. + + + + + + + + + +</dd> + + + + +<dt><a name="RevWalk:sorting"></a><strong>RevWalk:sorting</strong> (sort_mode)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/revwalk/git_revwalk_sorting">git_revwalk_sorting</a>:<p><p>Changing the sorting mode resets the walker. + + +<h3>Parameters</h3> +<ul> + + <li> + sort_mode: combination of GIT_SORT_XXX flags. Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + + + +</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> diff --git a/docs/modules/Signature.html b/docs/modules/Signature.html new file mode 100644 index 0000000..66eca21 --- /dev/null +++ b/docs/modules/Signature.html @@ -0,0 +1,354 @@ +<!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> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </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><strong>Signature</strong></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>Signature</code></h1> + +<p>Class "Signature". </p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#Signature.new">Signature.new</a> (name, email, time, offset)</td> + <td class="summary">Create a new Signature object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Signature.now">Signature.now</a> (name, email)</td> + <td class="summary">Create a new Signature object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Signature:email">Signature:email</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Signature:name">Signature:name</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Signature:when">Signature:when</a> ()</td> + <td class="summary">object method.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="Signature.new"></a><strong>Signature.new</strong> (name, email, time, offset)</dt> +<dd> +Create a new Signature object. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/signature/git_signature_new">git_signature_new</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + name: name of the person. Must be of type <code>string</code>. + </li> + + <li> + email: email of the person. Must be of type <code>string</code>. + </li> + + <li> + time: time when the action happened. Must be of type <code>integer</code>. + </li> + + <li> + offset: timezone offset in minutes for the time. Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Signature.html">Signature</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Signature.now"></a><strong>Signature.now</strong> (name, email)</dt> +<dd> +Create a new Signature object. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/signature/git_signature_now">git_signature_now</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + name: name of the person. Must be of type <code>string</code>. + </li> + + <li> + email: email of the person. Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Signature.html">Signature</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Signature:email"></a><strong>Signature:email</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</dd> + + + + +<dt><a name="Signature:name"></a><strong>Signature:name</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</dd> + + + + +<dt><a name="Signature:when"></a><strong>Signature:when</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return values:</h3> +<ol> + + <li><code>integer</code>. + + <li><code>integer</code>. + +</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> diff --git a/docs/modules/StrArray.html b/docs/modules/StrArray.html new file mode 100644 index 0000000..1fad380 --- /dev/null +++ b/docs/modules/StrArray.html @@ -0,0 +1,308 @@ +<!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> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </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><strong>StrArray</strong></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>StrArray</code></h1> + +<p>Class "StrArray". </p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#StrArray.new">StrArray.new</a> ()</td> + <td class="summary">Create a new StrArray object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#StrArray:count">StrArray:count</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#StrArray:free">StrArray:free</a> ()</td> + <td class="summary">Destroy this object (will be called by Garbage Collector).</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#StrArray:get_array">StrArray:get_array</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#StrArray:str">StrArray:str</a> (n)</td> + <td class="summary">object method.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="StrArray.new"></a><strong>StrArray.new</strong> ()</dt> +<dd> +Create a new StrArray object. + + + + + + + +<h3>Return value:</h3> +<a href="StrArray.html">StrArray</a>. + + + +</dd> + + + + +<dt><a name="StrArray:count"></a><strong>StrArray:count</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="StrArray:free"></a><strong>StrArray:free</strong> ()</dt> +<dd> +Destroy this object (will be called by Garbage Collector). + + + + + + + + + +</dd> + + + + +<dt><a name="StrArray:get_array"></a><strong>StrArray:get_array</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return value:</h3> +<code>nil</code>. + + + +</dd> + + + + +<dt><a name="StrArray:str"></a><strong>StrArray:str</strong> (n)</dt> +<dd> +object method. + + +<h3>Parameters</h3> +<ul> + + <li> + n: Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</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> diff --git a/docs/modules/Tag.html b/docs/modules/Tag.html new file mode 100644 index 0000000..7bc7d6a --- /dev/null +++ b/docs/modules/Tag.html @@ -0,0 +1,424 @@ +<!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> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </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><strong>Tag</strong></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>Tag</code></h1> + +<p>Class "Tag". Extends <a href="Object.html">Object</a><br /></p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#Object:free">Object:free</a> ()</td> + <td class="summary">Destroy this object (will be called by Garbage Collector).</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:id">Object:id</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:owner">Object:owner</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:type">Object:type</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Tag.lookup">Tag.lookup</a> (repo, id)</td> + <td class="summary">Create a new Tag object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Tag:message">Tag:message</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Tag:name">Tag:name</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Tag:tagger">Tag:tagger</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Tag:target">Tag:target</a> ()</td> + <td class="summary">object method.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="Object:free"></a><strong>Object:free</strong> ()</dt> +<dd> +Destroy this object (will be called by Garbage Collector). <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_free">git_object_free</a>:<p><p>This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.<p> IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. + + + + + + + + + +</dd> + + + + +<dt><a name="Object:id"></a><strong>Object:id</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_id">git_object_id</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<a href="OID.html">OID</a>. + + + +</dd> + + + + +<dt><a name="Object:owner"></a><strong>Object:owner</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_owner">git_object_owner</a>:<p><p>Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.<p> Any other operation may be run on the repository without affecting the object. + + + + + + + +<h3>Return value:</h3> +<a href="Repository.html">Repository</a>. + + + +</dd> + + + + +<dt><a name="Object:type"></a><strong>Object:type</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_type">git_object_type</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</dd> + + + + +<dt><a name="Tag.lookup"></a><strong>Tag.lookup</strong> (repo, id)</dt> +<dd> +Create a new Tag object. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/tag/git_tag_lookup">git_tag_lookup</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + repo: the repo to use when locating the tag.. Must be of type <a href="Repository.html">Repository</a>. + </li> + + <li> + id: identity of the tag to locate.. Must be of type <a href="OID.html">OID</a>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Tag.html">Tag</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Tag:message"></a><strong>Tag:message</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/tag/git_tag_message">git_tag_message</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</dd> + + + + +<dt><a name="Tag:name"></a><strong>Tag:name</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/tag/git_tag_name">git_tag_name</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</dd> + + + + +<dt><a name="Tag:tagger"></a><strong>Tag:tagger</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/tag/git_tag_tagger">git_tag_tagger</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<a href="Signature.html">Signature</a>. + + + +</dd> + + + + +<dt><a name="Tag:target"></a><strong>Tag:target</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/tag/git_tag_target">git_tag_target</a>:<p><p>This method performs a repository lookup for the given object and returns it + + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Object.html">Object</a> or <code>nil</code> on 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> diff --git a/docs/modules/Tree.html b/docs/modules/Tree.html new file mode 100644 index 0000000..d7b8481 --- /dev/null +++ b/docs/modules/Tree.html @@ -0,0 +1,411 @@ +<!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> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </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><strong>Tree</strong></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>Tree</code></h1> + +<p>Class "Tree". Extends <a href="Object.html">Object</a><br /></p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#Object:free">Object:free</a> ()</td> + <td class="summary">Destroy this object (will be called by Garbage Collector).</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:id">Object:id</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:owner">Object:owner</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Object:type">Object:type</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Tree.lookup">Tree.lookup</a> (repo, id)</td> + <td class="summary">Create a new Tree object.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Tree:entry_byindex">Tree:entry_byindex</a> (index)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Tree:entry_byname">Tree:entry_byname</a> (filename)</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#Tree:entrycount">Tree:entrycount</a> ()</td> + <td class="summary">object method.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="Object:free"></a><strong>Object:free</strong> ()</dt> +<dd> +Destroy this object (will be called by Garbage Collector). <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_free">git_object_free</a>:<p><p>This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.<p> IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. + + + + + + + + + +</dd> + + + + +<dt><a name="Object:id"></a><strong>Object:id</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_id">git_object_id</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<a href="OID.html">OID</a>. + + + +</dd> + + + + +<dt><a name="Object:owner"></a><strong>Object:owner</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_owner">git_object_owner</a>:<p><p>Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.<p> Any other operation may be run on the repository without affecting the object. + + + + + + + +<h3>Return value:</h3> +<a href="Repository.html">Repository</a>. + + + +</dd> + + + + +<dt><a name="Object:type"></a><strong>Object:type</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_type">git_object_type</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</dd> + + + + +<dt><a name="Tree.lookup"></a><strong>Tree.lookup</strong> (repo, id)</dt> +<dd> +Create a new Tree object. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/tree/git_tree_lookup">git_tree_lookup</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + repo: the repo to use when locating the tree.. Must be of type <a href="Repository.html">Repository</a>. + </li> + + <li> + id: identity of the tree to locate.. Must be of type <a href="OID.html">OID</a>. + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Tree.html">Tree</a> or <code>nil</code> on error. + + <li>Error string. + +</ol> + + + +</dd> + + + + +<dt><a name="Tree:entry_byindex"></a><strong>Tree:entry_byindex</strong> (index)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/tree/git_tree_entry_byindex">git_tree_entry_byindex</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + index: Must be of type <code>integer</code>. + </li> + +</ul> + + + + + + +<h3>Return value:</h3> +<a href="TreeEntry.html">TreeEntry</a>. + + + +</dd> + + + + +<dt><a name="Tree:entry_byname"></a><strong>Tree:entry_byname</strong> (filename)</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/tree/git_tree_entry_byname">git_tree_entry_byname</a>:<p><p> + + +<h3>Parameters</h3> +<ul> + + <li> + filename: the filename of the desired entry. Must be of type <code>string</code>. + </li> + +</ul> + + + + + + +<h3>Return value:</h3> +<a href="TreeEntry.html">TreeEntry</a>. + + + +</dd> + + + + +<dt><a name="Tree:entrycount"></a><strong>Tree:entrycount</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/tree/git_tree_entrycount">git_tree_entrycount</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</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> diff --git a/docs/modules/TreeEntry.html b/docs/modules/TreeEntry.html new file mode 100644 index 0000000..2033128 --- /dev/null +++ b/docs/modules/TreeEntry.html @@ -0,0 +1,296 @@ +<!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> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </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><strong>TreeEntry</strong></li> + + <li> + <a href="../modules/git2.html">git2</a> + </li> + +</ul> + + + +<!-- File list --> + + + + + + +</div><!-- id="navigation" --> + +<div id="content"> + +<h1>Module <code>TreeEntry</code></h1> + +<p>Class "TreeEntry". </p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#TreeEntry:attributes">TreeEntry:attributes</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#TreeEntry:id">TreeEntry:id</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#TreeEntry:name">TreeEntry:name</a> ()</td> + <td class="summary">object method.</td> + </tr> + + <tr> + <td class="name" nowrap><a href="#TreeEntry:object">TreeEntry:object</a> (repo, object)</td> + <td class="summary">object method.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="TreeEntry:attributes"></a><strong>TreeEntry:attributes</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/tree/git_tree_entry_attributes">git_tree_entry_attributes</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>integer</code>. + + + +</dd> + + + + +<dt><a name="TreeEntry:id"></a><strong>TreeEntry:id</strong> ()</dt> +<dd> +object method. + + + + + + + +<h3>Return value:</h3> +<a href="OID.html">OID</a>. + + + +</dd> + + + + +<dt><a name="TreeEntry:name"></a><strong>TreeEntry:name</strong> ()</dt> +<dd> +object method. <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/tree/git_tree_entry_name">git_tree_entry_name</a>:<p><p> + + + + + + + +<h3>Return value:</h3> +<code>string</code>. + + + +</dd> + + + + +<dt><a name="TreeEntry:object"></a><strong>TreeEntry:object</strong> (repo, object)</dt> +<dd> +object method. + + +<h3>Parameters</h3> +<ul> + + <li> + repo: repository where to lookup the pointed object. Must be of type <a href="Repository.html">Repository</a>. + </li> + + <li> + object: pointer to the converted object + </li> + +</ul> + + + + + + +<h3>Return values:</h3> +<ol> + + <li><a href="Object.html">Object</a> or <code>nil</code> on 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> diff --git a/docs/modules/git2.html b/docs/modules/git2.html new file mode 100644 index 0000000..9a44134 --- /dev/null +++ b/docs/modules/git2.html @@ -0,0 +1,202 @@ +<!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> + <a href="../modules/OID_Shorten.html">OID_Shorten</a> + </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><strong>git2</strong></li> + +</ul> + + + +<!-- File list --> + + + + + + +</div><!-- id="navigation" --> + +<div id="content"> + +<h1>Module <code>git2</code></h1> + +<p>Module git2. See <a href="http://libgit2.github.com/libgit2/#HEAD">libgit2 API docs</a>. <br />Class <a href="StrArray.html">StrArray</a> <br />Class <a href="Repository.html">Repository</a> <br />Class <a href="Config.html">Config</a> <br />Class <a href="OdbObject.html">OdbObject</a> <br />Class <a href="OID.html">OID</a> <br />Class <a href="OID_Shorten.html">OID_Shorten</a> <br />Class <a href="ODB.html">ODB</a> <br />Class <a href="ODBBackend.html">ODBBackend</a> <br />Class <a href="Index.html">Index</a> <br />Class <a href="IndexEntry.html">IndexEntry</a> <br />Class <a href="IndexEntryUnmerged.html">IndexEntryUnmerged</a> <br />Class <a href="Object.html">Object</a> <br />Class <a href="Blob.html">Blob</a> <br />Class <a href="Signature.html">Signature</a> <br />Class <a href="Commit.html">Commit</a> <br />Class <a href="Tree.html">Tree</a> <br />Class <a href="TreeEntry.html">TreeEntry</a> <br />Class <a href="Tag.html">Tag</a> <br />Class <a href="RevWalk.html">RevWalk</a> <br />Class <a href="Reference.html">Reference</a></p> + + + + + +<h2>Functions</h2> +<table class="function_list"> + + <tr> + <td class="name" nowrap><a href="#git2.version">git2.version</a> ()</td> + <td class="summary">module function.</td> + </tr> + +</table> + + + + + + +<br/> +<br/> + + + +<h2><a name="functions"></a>Functions</h2> +<dl class="function"> + + + +<dt><a name="git2.version"></a><strong>git2.version</strong> ()</dt> +<dd> +module function. + + + + + + + +<h3>Return value:</h3> +<code>nil</code>. + + + +</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> |