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