diff options
Diffstat (limited to 'docs/modules/Commit.html')
| -rw-r--r-- | docs/modules/Commit.html | 661 |
1 files changed, 661 insertions, 0 deletions
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> |