<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Class: IconArtist::GitRepo</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">IconArtist::GitRepo</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../files/lib/icon-artist/gitrepo_rb.html">
lib/icon-artist/gitrepo.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
Object
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000017">add</a>
<a href="#M000016">branches</a>
<a href="#M000013">checkout</a>
<a href="#M000012">clone</a>
<a href="#M000018">commit</a>
<a href="#M000020">config</a>
<a href="#M000015">in_branch</a>
<a href="#M000021">new</a>
<a href="#M000022">push</a>
<a href="#M000019">update</a>
<a href="#M000014">update_branches</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000012" class="method-detail">
<a name="M000012"></a>
<div class="method-heading">
<a href="GitRepo.src/M000012.html" target="Code" class="method-signature"
onclick="popupCode('GitRepo.src/M000012.html');return false;">
<span class="method-name">clone</span><span class="method-args">(repository,name)</span>
</a>
</div>
<div class="method-description">
<p>
Clone existing repository into <a href="GitRepo.html#M000021">new</a> one
</p>
<table>
<tr><td valign="top">repository:</td><td>path to existing repository
</td></tr>
<tr><td valign="top">name:</td><td>name/path to the <a href="GitRepo.html#M000021">new</a> repository
</td></tr>
</table>
</div>
</div>
<div id="method-M000021" class="method-detail">
<a name="M000021"></a>
<div class="method-heading">
<a href="GitRepo.src/M000021.html" target="Code" class="method-signature"
onclick="popupCode('GitRepo.src/M000021.html');return false;">
<span class="method-name">new</span><span class="method-args">(opts={})</span>
</a>
</div>
<div class="method-description">
<p>
Open git repository
</p>
<p>
options:
</p>
<pre>
:working_dir => '/path/to/git/repository'
</pre>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000017" class="method-detail">
<a name="M000017"></a>
<div class="method-heading">
<a href="GitRepo.src/M000017.html" target="Code" class="method-signature"
onclick="popupCode('GitRepo.src/M000017.html');return false;">
<span class="method-name">add</span><span class="method-args">(path='.')</span>
</a>
</div>
<div class="method-description">
<p>
Add files from the working directory to the git repository
</p>
</div>
</div>
<div id="method-M000016" class="method-detail">
<a name="M000016"></a>
<div class="method-heading">
<a href="GitRepo.src/M000016.html" target="Code" class="method-signature"
onclick="popupCode('GitRepo.src/M000016.html');return false;">
<span class="method-name">branches</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Branches hash, contains :remote and :local arrays
</p>
</div>
</div>
<div id="method-M000013" class="method-detail">
<a name="M000013"></a>
<div class="method-heading">
<a href="GitRepo.src/M000013.html" target="Code" class="method-signature"
onclick="popupCode('GitRepo.src/M000013.html');return false;">
<span class="method-name">checkout</span><span class="method-args">(branch = 'master')</span>
</a>
</div>
<div class="method-description">
<p>
Checkout branch
</p>
</div>
</div>
<div id="method-M000018" class="method-detail">
<a name="M000018"></a>
<div class="method-heading">
<a href="GitRepo.src/M000018.html" target="Code" class="method-signature"
onclick="popupCode('GitRepo.src/M000018.html');return false;">
<span class="method-name">commit</span><span class="method-args">(message)</span>
</a>
</div>
<div class="method-description">
<p>
Commit changes
</p>
<table>
<tr><td valign="top">message:</td><td><a href="GitRepo.html#M000018">commit</a> message
</td></tr>
</table>
</div>
</div>
<div id="method-M000020" class="method-detail">
<a name="M000020"></a>
<div class="method-heading">
<a href="GitRepo.src/M000020.html" target="Code" class="method-signature"
onclick="popupCode('GitRepo.src/M000020.html');return false;">
<span class="method-name">config</span><span class="method-args">(name = nil, value = nil)</span>
</a>
</div>
<div class="method-description">
<p>
Works like git <a href="GitRepo.html#M000020">config</a>
</p>
</div>
</div>
<div id="method-M000015" class="method-detail">
<a name="M000015"></a>
<div class="method-heading">
<a href="GitRepo.src/M000015.html" target="Code" class="method-signature"
onclick="popupCode('GitRepo.src/M000015.html');return false;">
<span class="method-name">in_branch</span><span class="method-args">() {|| ...}</span>
</a>
</div>
<div class="method-description">
<p>
Do some stuff within a branch then return back to the original branch
</p>
</div>
</div>
<div id="method-M000022" class="method-detail">
<a name="M000022"></a>
<div class="method-heading">
<a href="GitRepo.src/M000022.html" target="Code" class="method-signature"
onclick="popupCode('GitRepo.src/M000022.html');return false;">
<span class="method-name">push</span><span class="method-args">(remote='origin', branch='master')</span>
</a>
</div>
<div class="method-description">
<p>
Push changes to remote repository
</p>
<table>
<tr><td valign="top">remote:</td><td>remote repository
</td></tr>
<tr><td valign="top">branch:</td><td>branch to <a href="GitRepo.html#M000022">push</a>
</td></tr>
</table>
</div>
</div>
<div id="method-M000019" class="method-detail">
<a name="M000019"></a>
<div class="method-heading">
<a href="GitRepo.src/M000019.html" target="Code" class="method-signature"
onclick="popupCode('GitRepo.src/M000019.html');return false;">
<span class="method-name">update</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Make local repository up2date
</p>
</div>
</div>
<div id="method-M000014" class="method-detail">
<a name="M000014"></a>
<div class="method-heading">
<a href="GitRepo.src/M000014.html" target="Code" class="method-signature"
onclick="popupCode('GitRepo.src/M000014.html');return false;">
<span class="method-name">update_branches</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Sync local <a href="GitRepo.html#M000016">branches</a> with remote <a
href="GitRepo.html#M000016">branches</a>
</p>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
