diff options
| author | Robert G. Jakabosky <bobby@sharedrealm.com> | 2012-06-21 11:06:20 -0700 |
|---|---|---|
| committer | Robert G. Jakabosky <bobby@sharedrealm.com> | 2012-06-21 11:06:20 -0700 |
| commit | 2c920a74a9653adb625070a5f416f6394aae8147 (patch) | |
| tree | ca35ffd1c9edfb93420e32eb473fd19d19eef93c /docs/modules/Repository.html | |
| parent | c5b97353696f5d82ca15f69f00f6c4c54fb2afba (diff) | |
| download | luagit2-2c920a74a9653adb625070a5f416f6394aae8147.tar.gz | |
Commit generated API docs.
Diffstat (limited to 'docs/modules/Repository.html')
| -rw-r--r-- | docs/modules/Repository.html | 668 |
1 files changed, 668 insertions, 0 deletions
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> |