git 1.0.2 → 1.0.3

data/README

@@ -19,6 +19,34 @@ but eventually I'll replace that with either C bindings
 to libgit or libgit-thin, or I'll write pure ruby
 handlers for at least some of the Git stuff.
 
+= Major Objects
+
+Git::Base - this is the object returned from a Git.open or Git.clone.  
+Most major actions are called from this object.
+
+Git::Object - this is the base object for your tree, blob and commit objects,
+returned from @git.gtree or @git.object calls.  the Git::AbstractObject will
+have most of the calls in common for all those objects.
+
+Git::Diff - returns from a @git.diff command.  It is an Enumerable that returns
+Git::Diff:DiffFile objects from which you can get per file patches and insertion/deletion
+statistics.  You can also get total statistics from the Git::Diff object directly.
+
+Git::Status - returns from a @git.status command.  It is an Enumerable that returns
+Git:Status::StatusFile objects for each object in git, which includes files in the working
+directory, in the index and in the repository.  Similar to running 'git status' on the command
+line to determine untracked and changed files.
+
+Git::Branches - Enumerable object that holds Git::Branch objects.  You can call .local or .remote
+on it to filter to just your local or remote branches.
+
+Git::Remote - A reference to a remote repository that is tracked by this repository.
+
+Git::Log - An Enumerable object that references all the Git::Object::Commit objects that encompass
+your log query, which can be constructed through methods on the Git::Log object, like:
+
+ @git.log(20).object("HEAD^").since("2 weeks ago").between('v2.6', 'v2.7').each { |commit| [block] } 
+
 
 = Examples
 
@@ -176,3 +204,44 @@ And here are the operations that will need to write to your git repository.
 
    g.push
    g.push(g.remote('name'))
+
+
+Some examples of more low-level index and tree operations
+
+   g.with_temp_index do 
+
+     g.read_tree(tree3) # calls self.index.read_tree
+     g.read_tree(tree1, :prefix => 'hi/')
+
+     c = g.commit_tree('message')
+     # or #
+     t = g.write_tree
+     c = g.commit_tree(t, :message => 'message', :parents => [sha1, sha2])
+
+     g.branch('branch_name').update_ref(c)
+     g.update_ref(branch, c)
+
+     g.with_temp_working do # new blank working directory
+       g.checkout
+       g.checkout(another_index)
+       g.commit # commits to temp_index
+     end    
+   end
+
+   g.set_index('/path/to/index')
+   
+   
+   g.with_index(path) do 
+     # calls set_index, then switches back after
+   end
+   
+   g.with_working(dir) do
+   # calls set_working, then switches back after
+   end
+   
+   g.with_temp_working(dir) do
+     g.checkout_index(:prefix => dir, :path_limiter => path)
+     # do file work
+     g.commit # commits to index
+   end
+   

data/doc/classes/Git.html

@@ -55,6 +55,10 @@
         <tr class="top-aligned-row">
             <td><strong>In:</strong></td>
             <td>
+                <a href="../files/lib/git/author_rb.html">
+                lib/git/author.rb
+                </a>
+        <br />
                 <a href="../files/lib/git/base_rb.html">
                 lib/git/base.rb
                 </a>
@@ -124,6 +128,31 @@
 
   <div id="contextContent">
 
+    <div id="description">
+      <p>
+<a href="Git.html">Git</a>/Ruby Library
+</p>
+<p>
+This provides bindings for working with git in complex interactions,
+including branching and merging, object inspection and manipulation,
+history, patch generation and more. You should be able to do most
+fundamental git operations with this library.
+</p>
+<p>
+This module provides the basic functions to open a git reference to work
+with. You can open a working directory, open a bare repository, initialize
+a new repo or clone an existing remote repository.
+</p>
+<table>
+<tr><td valign="top"><a href="Git/Author.html">Author</a>:</td><td>Scott Chacon (<a href="mailto:schacon@gmail.com">schacon@gmail.com</a>)
+
+</td></tr>
+<tr><td valign="top">License:</td><td>MIT License
+
+</td></tr>
+</table>
+
+    </div>
 
 
    </div>
@@ -149,7 +178,8 @@
     <div id="class-list">
       <h3 class="section-bar">Classes and Modules</h3>
 
-      Class <a href="Git/Base.html" class="link">Git::Base</a><br />
+      Class <a href="Git/Author.html" class="link">Git::Author</a><br />
+Class <a href="Git/Base.html" class="link">Git::Base</a><br />
 Class <a href="Git/Branch.html" class="link">Git::Branch</a><br />
 Class <a href="Git/Branches.html" class="link">Git::Branches</a><br />
 Class <a href="Git/Diff.html" class="link">Git::Diff</a><br />
@@ -175,7 +205,7 @@ Class <a href="Git/WorkingDirectory.html" class="link">Git::WorkingDirectory</a>
         <tr class="top-aligned-row context-row">
           <td class="context-item-name">VERSION</td>
           <td>=</td>
-          <td class="context-item-value">'1.0.1'</td>
+          <td class="context-item-value">'1.0.3'</td>
         </tr>
         </table>
       </div>
@@ -200,11 +230,19 @@ Class <a href="Git/WorkingDirectory.html" class="link">Git::WorkingDirectory</a>
         </div>
       
         <div class="method-description">
+          <p>
+open a bare repository
+</p>
+<p>
+this takes the path to a bare git repo it expects not to be able to use a
+working directory so you can&#8217;t checkout stuff, commit things, etc.
+but you can do most read operations
+</p>
           <p><a class="source-toggle" href="#"
             onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000001-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git.rb, line 36</span>
+<span class="ruby-comment cmt"># File lib/git.rb, line 51</span>
   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">bare</span>(<span class="ruby-identifier">git_dir</span>)
     <span class="ruby-constant">Base</span>.<span class="ruby-identifier">bare</span>(<span class="ruby-identifier">git_dir</span>)
   <span class="ruby-keyword kw">end</span>
@@ -223,11 +261,28 @@ Class <a href="Git/WorkingDirectory.html" class="link">Git::WorkingDirectory</a>
         </div>
       
         <div class="method-description">
+          <p>
+clones a remote repository
+</p>
+<p>
+options
+</p>
+<pre>
+  :bare =&gt; true (does a bare clone)
+  :repository =&gt; '/path/to/alt_git_dir'
+  :index =&gt; '/path/to/alt_index_file'
+</pre>
+<p>
+example
+</p>
+<pre>
+ Git.clone('git://repo.or.cz/rubygit.git', 'clone.git', :bare =&gt; true)
+</pre>
           <p><a class="source-toggle" href="#"
             onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000004-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git.rb, line 48</span>
+<span class="ruby-comment cmt"># File lib/git.rb, line 88</span>
   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">clone</span>(<span class="ruby-identifier">repository</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span> = {})
     <span class="ruby-constant">Base</span>.<span class="ruby-identifier">clone</span>(<span class="ruby-identifier">repository</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span>)
   <span class="ruby-keyword kw">end</span>
@@ -246,11 +301,21 @@ Class <a href="Git/WorkingDirectory.html" class="link">Git::WorkingDirectory</a>
         </div>
       
         <div class="method-description">
+          <p>
+initialize a new git repository, defaults to the current working directory
+</p>
+<p>
+options
+</p>
+<pre>
+  :repository =&gt; '/path/to/alt_git_dir'
+  :index =&gt; '/path/to/alt_index_file'
+</pre>
           <p><a class="source-toggle" href="#"
             onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000003-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git.rb, line 44</span>
+<span class="ruby-comment cmt"># File lib/git.rb, line 74</span>
   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">init</span>(<span class="ruby-identifier">working_dir</span> = <span class="ruby-value str">'.'</span>, <span class="ruby-identifier">options</span> = {})
     <span class="ruby-constant">Base</span>.<span class="ruby-identifier">init</span>(<span class="ruby-identifier">working_dir</span>, <span class="ruby-identifier">options</span>)
   <span class="ruby-keyword kw">end</span>
@@ -269,11 +334,27 @@ Class <a href="Git/WorkingDirectory.html" class="link">Git::WorkingDirectory</a>
         </div>
       
         <div class="method-description">
+          <p>
+open an existing git working directory
+</p>
+<p>
+this will most likely be the most common way to create a git reference,
+referring to a working directory. if not provided in the options, the
+library will assume your git_dir and index are in the default place (.git/,
+.git/index)
+</p>
+<p>
+options
+</p>
+<pre>
+  :repository =&gt; '/path/to/alt_git_dir'
+  :index =&gt; '/path/to/alt_index_file'
+</pre>
           <p><a class="source-toggle" href="#"
             onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000002-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git.rb, line 40</span>
+<span class="ruby-comment cmt"># File lib/git.rb, line 65</span>
   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">working_dir</span>, <span class="ruby-identifier">options</span> = {})
     <span class="ruby-constant">Base</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">working_dir</span>, <span class="ruby-identifier">options</span>)
   <span class="ruby-keyword kw">end</span>

data/doc/classes/Git/Author.html

@@ -0,0 +1,175 @@
+<?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: Git::Author</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">Git::Author</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/git/author_rb.html">
+                lib/git/author.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                <a href="Object.html">
+                Object
+               </a>
+            </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="#M000024">new</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">date</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">email</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">name</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        </table>
+      </div>
+    </div>
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000024" class="method-detail">
+        <a name="M000024"></a>
+
+        <div class="method-heading">
+          <a href="#M000024" class="method-signature">
+          <span class="method-name">new</span><span class="method-args">(author_string)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000024-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000024-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git/author.rb, line 5</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">author_string</span>)
+      <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">m</span> = <span class="ruby-regexp re">/(.*?) &lt;(.*?)&gt; (\d+) (.*)/</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">author_string</span>)
+        <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">m</span>[<span class="ruby-value">1</span>]
+        <span class="ruby-ivar">@email</span> = <span class="ruby-identifier">m</span>[<span class="ruby-value">2</span>]
+        <span class="ruby-ivar">@date</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">at</span>(<span class="ruby-identifier">m</span>[<span class="ruby-value">3</span>].<span class="ruby-identifier">to_i</span>)
+      <span class="ruby-keyword kw">end</span>
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </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>

data/doc/classes/Git/Base.html

@@ -88,48 +88,62 @@
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000100">add</a>&nbsp;&nbsp;
-      <a href="#M000112">add_remote</a>&nbsp;&nbsp;
-      <a href="#M000115">add_tag</a>&nbsp;&nbsp;
-      <a href="#M000077">bare</a>&nbsp;&nbsp;
-      <a href="#M000095">branch</a>&nbsp;&nbsp;
-      <a href="#M000094">branches</a>&nbsp;&nbsp;
-      <a href="#M000085">chdir</a>&nbsp;&nbsp;
-      <a href="#M000106">checkout</a>&nbsp;&nbsp;
-      <a href="#M000080">clone</a>&nbsp;&nbsp;
-      <a href="#M000104">commit</a>&nbsp;&nbsp;
-      <a href="#M000105">commit_all</a>&nbsp;&nbsp;
-      <a href="#M000087">config</a>&nbsp;&nbsp;
-      <a href="#M000118">current_branch</a>&nbsp;&nbsp;
-      <a href="#M000099">diff</a>&nbsp;&nbsp;
-      <a href="#M000082">dir</a>&nbsp;&nbsp;
-      <a href="#M000107">fetch</a>&nbsp;&nbsp;
-      <a href="#M000091">gblob</a>&nbsp;&nbsp;
-      <a href="#M000090">gcommit</a>&nbsp;&nbsp;
-      <a href="#M000098">grep</a>&nbsp;&nbsp;
-      <a href="#M000089">gtree</a>&nbsp;&nbsp;
-      <a href="#M000084">index</a>&nbsp;&nbsp;
-      <a href="#M000079">init</a>&nbsp;&nbsp;
-      <a href="#M000097">lib</a>&nbsp;&nbsp;
-      <a href="#M000092">log</a>&nbsp;&nbsp;
-      <a href="#M000109">merge</a>&nbsp;&nbsp;
-      <a href="#M000081">new</a>&nbsp;&nbsp;
-      <a href="#M000088">object</a>&nbsp;&nbsp;
-      <a href="#M000078">open</a>&nbsp;&nbsp;
-      <a href="#M000110">pull</a>&nbsp;&nbsp;
-      <a href="#M000108">push</a>&nbsp;&nbsp;
-      <a href="#M000096">remote</a>&nbsp;&nbsp;
-      <a href="#M000111">remotes</a>&nbsp;&nbsp;
-      <a href="#M000101">remove</a>&nbsp;&nbsp;
-      <a href="#M000116">repack</a>&nbsp;&nbsp;
-      <a href="#M000083">repo</a>&nbsp;&nbsp;
-      <a href="#M000086">repo_size</a>&nbsp;&nbsp;
-      <a href="#M000102">reset</a>&nbsp;&nbsp;
-      <a href="#M000103">reset_hard</a>&nbsp;&nbsp;
-      <a href="#M000117">revparse</a>&nbsp;&nbsp;
-      <a href="#M000093">status</a>&nbsp;&nbsp;
-      <a href="#M000114">tag</a>&nbsp;&nbsp;
-      <a href="#M000113">tags</a>&nbsp;&nbsp;
+      <a href="#M000114">add</a>&nbsp;&nbsp;
+      <a href="#M000126">add_remote</a>&nbsp;&nbsp;
+      <a href="#M000129">add_tag</a>&nbsp;&nbsp;
+      <a href="#M000130">archive</a>&nbsp;&nbsp;
+      <a href="#M000089">bare</a>&nbsp;&nbsp;
+      <a href="#M000109">branch</a>&nbsp;&nbsp;
+      <a href="#M000108">branches</a>&nbsp;&nbsp;
+      <a href="#M000099">chdir</a>&nbsp;&nbsp;
+      <a href="#M000120">checkout</a>&nbsp;&nbsp;
+      <a href="#M000134">checkout_index</a>&nbsp;&nbsp;
+      <a href="#M000092">clone</a>&nbsp;&nbsp;
+      <a href="#M000118">commit</a>&nbsp;&nbsp;
+      <a href="#M000119">commit_all</a>&nbsp;&nbsp;
+      <a href="#M000137">commit_tree</a>&nbsp;&nbsp;
+      <a href="#M000101">config</a>&nbsp;&nbsp;
+      <a href="#M000144">current_branch</a>&nbsp;&nbsp;
+      <a href="#M000113">diff</a>&nbsp;&nbsp;
+      <a href="#M000094">dir</a>&nbsp;&nbsp;
+      <a href="#M000121">fetch</a>&nbsp;&nbsp;
+      <a href="#M000105">gblob</a>&nbsp;&nbsp;
+      <a href="#M000104">gcommit</a>&nbsp;&nbsp;
+      <a href="#M000112">grep</a>&nbsp;&nbsp;
+      <a href="#M000103">gtree</a>&nbsp;&nbsp;
+      <a href="#M000096">index</a>&nbsp;&nbsp;
+      <a href="#M000091">init</a>&nbsp;&nbsp;
+      <a href="#M000111">lib</a>&nbsp;&nbsp;
+      <a href="#M000106">log</a>&nbsp;&nbsp;
+      <a href="#M000140">ls_files</a>&nbsp;&nbsp;
+      <a href="#M000123">merge</a>&nbsp;&nbsp;
+      <a href="#M000093">new</a>&nbsp;&nbsp;
+      <a href="#M000102">object</a>&nbsp;&nbsp;
+      <a href="#M000090">open</a>&nbsp;&nbsp;
+      <a href="#M000124">pull</a>&nbsp;&nbsp;
+      <a href="#M000122">push</a>&nbsp;&nbsp;
+      <a href="#M000135">read_tree</a>&nbsp;&nbsp;
+      <a href="#M000110">remote</a>&nbsp;&nbsp;
+      <a href="#M000125">remotes</a>&nbsp;&nbsp;
+      <a href="#M000115">remove</a>&nbsp;&nbsp;
+      <a href="#M000131">repack</a>&nbsp;&nbsp;
+      <a href="#M000095">repo</a>&nbsp;&nbsp;
+      <a href="#M000100">repo_size</a>&nbsp;&nbsp;
+      <a href="#M000116">reset</a>&nbsp;&nbsp;
+      <a href="#M000117">reset_hard</a>&nbsp;&nbsp;
+      <a href="#M000143">revparse</a>&nbsp;&nbsp;
+      <a href="#M000098">set_index</a>&nbsp;&nbsp;
+      <a href="#M000097">set_working</a>&nbsp;&nbsp;
+      <a href="#M000107">status</a>&nbsp;&nbsp;
+      <a href="#M000128">tag</a>&nbsp;&nbsp;
+      <a href="#M000127">tags</a>&nbsp;&nbsp;
+      <a href="#M000139">update_ref</a>&nbsp;&nbsp;
+      <a href="#M000132">with_index</a>&nbsp;&nbsp;
+      <a href="#M000133">with_temp_index</a>&nbsp;&nbsp;
+      <a href="#M000142">with_temp_working</a>&nbsp;&nbsp;
+      <a href="#M000141">with_working</a>&nbsp;&nbsp;
+      <a href="#M000138">write_and_commit_tree</a>&nbsp;&nbsp;
+      <a href="#M000136">write_tree</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -151,11 +165,11 @@
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000077" class="method-detail">
-        <a name="M000077"></a>
+      <div id="method-M000089" class="method-detail">
+        <a name="M000089"></a>
 
         <div class="method-heading">
-          <a href="#M000077" class="method-signature">
+          <a href="#M000089" class="method-signature">
           <span class="method-name">bare</span><span class="method-args">(git_dir)</span>
           </a>
         </div>
@@ -166,10 +180,10 @@ opens a bare <a href="../Git.html">Git</a> <a
 href="Repository.html">Repository</a> - no working directory options
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000077-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000077-source">
+            onclick="toggleCode('M000089-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000089-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 10</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 12</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">bare</span>(<span class="ruby-identifier">git_dir</span>)
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">:repository</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">git_dir</span>
     <span class="ruby-keyword kw">end</span>
@@ -178,11 +192,11 @@ href="Repository.html">Repository</a> - no working directory options
         </div>
       </div>
 
-      <div id="method-M000080" class="method-detail">
-        <a name="M000080"></a>
+      <div id="method-M000092" class="method-detail">
+        <a name="M000092"></a>
 
         <div class="method-heading">
-          <a href="#M000080" class="method-signature">
+          <a href="#M000092" class="method-signature">
           <span class="method-name">clone</span><span class="method-args">(repository, name, opts = {})</span>
           </a>
         </div>
@@ -207,10 +221,10 @@ options:
    :index_file
 </pre>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000080-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000080-source">
+            onclick="toggleCode('M000092-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000092-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 58</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 60</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">clone</span>(<span class="ruby-identifier">repository</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">opts</span> = {})
       <span class="ruby-comment cmt"># run git-clone </span>
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Lib</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">clone</span>(<span class="ruby-identifier">repository</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">opts</span>))
@@ -220,11 +234,11 @@ options:
         </div>
       </div>
 
-      <div id="method-M000079" class="method-detail">
-        <a name="M000079"></a>
+      <div id="method-M000091" class="method-detail">
+        <a name="M000091"></a>
 
         <div class="method-heading">
-          <a href="#M000079" class="method-signature">
+          <a href="#M000091" class="method-signature">
           <span class="method-name">init</span><span class="method-args">(working_dir, opts = {})</span>
           </a>
         </div>
@@ -241,10 +255,10 @@ options:
  :index_file
 </pre>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000079-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000079-source">
+            onclick="toggleCode('M000091-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000091-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 29</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 31</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">init</span>(<span class="ruby-identifier">working_dir</span>, <span class="ruby-identifier">opts</span> = {})
       <span class="ruby-identifier">default</span> = {<span class="ruby-identifier">:working_directory</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">working_dir</span>,
                  <span class="ruby-identifier">:repository</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">working_dir</span>, <span class="ruby-value str">'.git'</span>)}
@@ -265,21 +279,21 @@ options:
         </div>
       </div>
 
-      <div id="method-M000081" class="method-detail">
-        <a name="M000081"></a>
+      <div id="method-M000093" class="method-detail">
+        <a name="M000093"></a>
 
         <div class="method-heading">
-          <a href="#M000081" class="method-signature">
+          <a href="#M000093" class="method-signature">
           <span class="method-name">new</span><span class="method-args">(options = {})</span>
           </a>
         </div>
       
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000081-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000081-source">
+            onclick="toggleCode('M000093-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000093-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 63</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 65</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">options</span> = {})
       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">working_dir</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:working_directory</span>]
         <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:repository</span>] = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">working_dir</span>, <span class="ruby-value str">'.git'</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">options</span>[<span class="ruby-identifier">:repository</span>]
@@ -295,11 +309,11 @@ options:
         </div>
       </div>
 
-      <div id="method-M000078" class="method-detail">
-        <a name="M000078"></a>
+      <div id="method-M000090" class="method-detail">
+        <a name="M000090"></a>
 
         <div class="method-heading">
-          <a href="#M000078" class="method-signature">
+          <a href="#M000090" class="method-signature">
           <span class="method-name">open</span><span class="method-args">(working_dir, opts={})</span>
           </a>
         </div>
@@ -310,10 +324,10 @@ opens a new <a href="../Git.html">Git</a> Project from a working directory
 you can specify non-standard git_dir and index file in the options
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000078-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000078-source">
+            onclick="toggleCode('M000090-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000090-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 16</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 18</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">working_dir</span>, <span class="ruby-identifier">opts</span>={})    
       <span class="ruby-identifier">default</span> = {<span class="ruby-identifier">:working_directory</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">working_dir</span>}
       <span class="ruby-identifier">git_options</span> = <span class="ruby-identifier">default</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">opts</span>)
@@ -327,11 +341,11 @@ you can specify non-standard git_dir and index file in the options
 
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000100" class="method-detail">
-        <a name="M000100"></a>
+      <div id="method-M000114" class="method-detail">
+        <a name="M000114"></a>
 
         <div class="method-heading">
-          <a href="#M000100" class="method-signature">
+          <a href="#M000114" class="method-signature">
           <span class="method-name">add</span><span class="method-args">(path = '.')</span>
           </a>
         </div>
@@ -341,10 +355,10 @@ you can specify non-standard git_dir and index file in the options
 adds files from the working directory to the git repository
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000100-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000100-source">
+            onclick="toggleCode('M000114-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000114-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 162</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 234</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add</span>(<span class="ruby-identifier">path</span> = <span class="ruby-value str">'.'</span>)
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">path</span>)
     <span class="ruby-keyword kw">end</span>
@@ -353,21 +367,30 @@ adds files from the working directory to the git repository
         </div>
       </div>
 
-      <div id="method-M000112" class="method-detail">
-        <a name="M000112"></a>
+      <div id="method-M000126" class="method-detail">
+        <a name="M000126"></a>
 
         <div class="method-heading">
-          <a href="#M000112" class="method-signature">
+          <a href="#M000126" class="method-signature">
           <span class="method-name">add_remote</span><span class="method-args">(name, url, opts = {})</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+adds a new remote to this repository url can be a git url or a <a
+href="Base.html">Git::Base</a> object if it&#8217;s a local reference
+</p>
+<pre>
+ @git.add_remote('scotts_git', 'git://repo.or.cz/rubygit.git')
+ @git.fetch('scotts_git')
+ @git.merge('scotts_git/master')
+</pre>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000112-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000112-source">
+            onclick="toggleCode('M000126-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000126-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 213</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 312</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_remote</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">url</span>, <span class="ruby-identifier">opts</span> = {})
       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">url</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>)
         <span class="ruby-identifier">url</span> = <span class="ruby-identifier">url</span>.<span class="ruby-identifier">repo</span>.<span class="ruby-identifier">path</span>
@@ -380,21 +403,24 @@ adds files from the working directory to the git repository
         </div>
       </div>
 
-      <div id="method-M000115" class="method-detail">
-        <a name="M000115"></a>
+      <div id="method-M000129" class="method-detail">
+        <a name="M000129"></a>
 
         <div class="method-heading">
-          <a href="#M000115" class="method-signature">
+          <a href="#M000129" class="method-signature">
           <span class="method-name">add_tag</span><span class="method-args">(tag_name)</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+creates a new git tag (Git::Tag)
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000115-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000115-source">
+            onclick="toggleCode('M000129-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000129-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 229</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 331</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_tag</span>(<span class="ruby-identifier">tag_name</span>)
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">tag</span>(<span class="ruby-identifier">tag_name</span>)
       <span class="ruby-identifier">tag</span>(<span class="ruby-identifier">tag_name</span>)
@@ -404,21 +430,50 @@ adds files from the working directory to the git repository
         </div>
       </div>
 
-      <div id="method-M000095" class="method-detail">
-        <a name="M000095"></a>
+      <div id="method-M000130" class="method-detail">
+        <a name="M000130"></a>
 
         <div class="method-heading">
-          <a href="#M000095" class="method-signature">
+          <a href="#M000130" class="method-signature">
+          <span class="method-name">archive</span><span class="method-args">(treeish, file = nil, opts = {})</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+creates an archive file of the given tree-ish
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000130-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000130-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 337</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">archive</span>(<span class="ruby-identifier">treeish</span>, <span class="ruby-identifier">file</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">opts</span> = {})
+      <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">object</span>(<span class="ruby-identifier">treeish</span>).<span class="ruby-identifier">archive</span>(<span class="ruby-identifier">file</span>, <span class="ruby-identifier">opts</span>)
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000109" class="method-detail">
+        <a name="M000109"></a>
+
+        <div class="method-heading">
+          <a href="#M000109" class="method-signature">
           <span class="method-name">branch</span><span class="method-args">(branch_name = 'master')</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+returns a <a href="Branch.html">Git::Branch</a> object for branch_name
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000095-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000095-source">
+            onclick="toggleCode('M000109-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000109-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 140</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 189</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">branch</span>(<span class="ruby-identifier">branch_name</span> = <span class="ruby-value str">'master'</span>)
       <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Branch</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">branch_name</span>)
     <span class="ruby-keyword kw">end</span>
@@ -427,21 +482,25 @@ adds files from the working directory to the git repository
         </div>
       </div>
 
-      <div id="method-M000094" class="method-detail">
-        <a name="M000094"></a>
+      <div id="method-M000108" class="method-detail">
+        <a name="M000108"></a>
 
         <div class="method-heading">
-          <a href="#M000094" class="method-signature">
+          <a href="#M000108" class="method-signature">
           <span class="method-name">branches</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+returns a <a href="Branches.html">Git::Branches</a> object of all the <a
+href="Branch.html">Git::Branch</a> objects for this repo
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000094-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000094-source">
+            onclick="toggleCode('M000108-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000108-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 136</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 184</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">branches</span>
       <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Branches</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>)
     <span class="ruby-keyword kw">end</span>
@@ -450,21 +509,34 @@ adds files from the working directory to the git repository
         </div>
       </div>
 
-      <div id="method-M000085" class="method-detail">
-        <a name="M000085"></a>
+      <div id="method-M000099" class="method-detail">
+        <a name="M000099"></a>
 
         <div class="method-heading">
-          <a href="#M000085" class="method-signature">
+          <a href="#M000099" class="method-signature">
           <span class="method-name">chdir</span><span class="method-args">() {|dir.path| ...}</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+changes current working directory for a block to the git working directory
+</p>
+<p>
+example
+</p>
+<pre>
+ @git.chdir do
+   # write files
+   @git.add
+   @git.commit('message')
+ end
+</pre>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000085-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000085-source">
+            onclick="toggleCode('M000099-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000099-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 87</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 115</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">chdir</span>
       <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span>(<span class="ruby-identifier">dir</span>.<span class="ruby-identifier">path</span>) <span class="ruby-keyword kw">do</span>
         <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">dir</span>.<span class="ruby-identifier">path</span>
@@ -475,21 +547,24 @@ adds files from the working directory to the git repository
         </div>
       </div>
 
-      <div id="method-M000106" class="method-detail">
-        <a name="M000106"></a>
+      <div id="method-M000120" class="method-detail">
+        <a name="M000120"></a>
 
         <div class="method-heading">
-          <a href="#M000106" class="method-signature">
+          <a href="#M000120" class="method-signature">
           <span class="method-name">checkout</span><span class="method-args">(branch = 'master', opts = {})</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+checks out a branch as the new git working directory
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000106-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000106-source">
+            onclick="toggleCode('M000120-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000120-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 188</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 268</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">checkout</span>(<span class="ruby-identifier">branch</span> = <span class="ruby-value str">'master'</span>, <span class="ruby-identifier">opts</span> = {})
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">checkout</span>(<span class="ruby-identifier">branch</span>, <span class="ruby-identifier">opts</span>)
     <span class="ruby-keyword kw">end</span>
@@ -498,21 +573,47 @@ adds files from the working directory to the git repository
         </div>
       </div>
 
-      <div id="method-M000104" class="method-detail">
-        <a name="M000104"></a>
+      <div id="method-M000134" class="method-detail">
+        <a name="M000134"></a>
 
         <div class="method-heading">
-          <a href="#M000104" class="method-signature">
+          <a href="#M000134" class="method-signature">
+          <span class="method-name">checkout_index</span><span class="method-args">(opts = {})</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000134-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000134-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 364</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">checkout_index</span>(<span class="ruby-identifier">opts</span> = {})
+      <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">checkout_index</span>(<span class="ruby-identifier">opts</span>)
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000118" class="method-detail">
+        <a name="M000118"></a>
+
+        <div class="method-heading">
+          <a href="#M000118" class="method-signature">
           <span class="method-name">commit</span><span class="method-args">(message, opts = {})</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+commits all pending changes in the index file to the git repository
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000104-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000104-source">
+            onclick="toggleCode('M000118-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000118-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 179</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 255</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">commit</span>(<span class="ruby-identifier">message</span>, <span class="ruby-identifier">opts</span> = {})
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">commit</span>(<span class="ruby-identifier">message</span>, <span class="ruby-identifier">opts</span>)
     <span class="ruby-keyword kw">end</span>
@@ -521,21 +622,26 @@ adds files from the working directory to the git repository
         </div>
       </div>
 
-      <div id="method-M000105" class="method-detail">
-        <a name="M000105"></a>
+      <div id="method-M000119" class="method-detail">
+        <a name="M000119"></a>
 
         <div class="method-heading">
-          <a href="#M000105" class="method-signature">
+          <a href="#M000119" class="method-signature">
           <span class="method-name">commit_all</span><span class="method-args">(message, opts = {})</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+commits all pending changes in the index file to the git repository, but
+automatically adds all modified files without having to explicitly calling
+@git.add() on them.
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000105-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000105-source">
+            onclick="toggleCode('M000119-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000119-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 183</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 262</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">commit_all</span>(<span class="ruby-identifier">message</span>, <span class="ruby-identifier">opts</span> = {})
       <span class="ruby-identifier">opts</span> = {<span class="ruby-identifier">:add_all</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">true</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">opts</span>)
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">commit</span>(<span class="ruby-identifier">message</span>, <span class="ruby-identifier">opts</span>)
@@ -545,11 +651,34 @@ adds files from the working directory to the git repository
         </div>
       </div>
 
-      <div id="method-M000087" class="method-detail">
-        <a name="M000087"></a>
+      <div id="method-M000137" class="method-detail">
+        <a name="M000137"></a>
+
+        <div class="method-heading">
+          <a href="#M000137" class="method-signature">
+          <span class="method-name">commit_tree</span><span class="method-args">(tree = nil, opts = {})</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000137-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000137-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 376</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">commit_tree</span>(<span class="ruby-identifier">tree</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">opts</span> = {})
+      <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Object</span><span class="ruby-operator">::</span><span class="ruby-constant">Commit</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>, <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">commit_tree</span>(<span class="ruby-identifier">tree</span>, <span class="ruby-identifier">opts</span>))
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000101" class="method-detail">
+        <a name="M000101"></a>
 
         <div class="method-heading">
-          <a href="#M000087" class="method-signature">
+          <a href="#M000101" class="method-signature">
           <span class="method-name">config</span><span class="method-args">(name = nil, value = nil)</span>
           </a>
         </div>
@@ -562,10 +691,10 @@ value g.config(&#8216;user.name&#8217;) # returns &#8216;Scott
 Chacon&#8217; g.config # returns whole config hash
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000087-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000087-source">
+            onclick="toggleCode('M000101-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000101-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 105</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 134</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">config</span>(<span class="ruby-identifier">name</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">value</span> = <span class="ruby-keyword kw">nil</span>)
       <span class="ruby-keyword kw">if</span>(<span class="ruby-identifier">name</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">value</span>)
         <span class="ruby-comment cmt"># set value</span>
@@ -583,21 +712,24 @@ Chacon&#8217; g.config # returns whole config hash
         </div>
       </div>
 
-      <div id="method-M000118" class="method-detail">
-        <a name="M000118"></a>
+      <div id="method-M000144" class="method-detail">
+        <a name="M000144"></a>
 
         <div class="method-heading">
-          <a href="#M000118" class="method-signature">
+          <a href="#M000144" class="method-signature">
           <span class="method-name">current_branch</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+returns the name of the branch the working directory is currently on
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000118-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000118-source">
+            onclick="toggleCode('M000144-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000144-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 244</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 425</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">current_branch</span>
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">branch_current</span>
     <span class="ruby-keyword kw">end</span>
@@ -606,21 +738,24 @@ Chacon&#8217; g.config # returns whole config hash
         </div>
       </div>
 
-      <div id="method-M000099" class="method-detail">
-        <a name="M000099"></a>
+      <div id="method-M000113" class="method-detail">
+        <a name="M000113"></a>
 
         <div class="method-heading">
-          <a href="#M000099" class="method-signature">
+          <a href="#M000113" class="method-signature">
           <span class="method-name">diff</span><span class="method-args">(objectish = 'HEAD', obj2 = nil)</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+returns a <a href="Diff.html">Git::Diff</a> object
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000099-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000099-source">
+            onclick="toggleCode('M000113-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000113-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 157</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 229</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">diff</span>(<span class="ruby-identifier">objectish</span> = <span class="ruby-value str">'HEAD'</span>, <span class="ruby-identifier">obj2</span> = <span class="ruby-keyword kw">nil</span>)
       <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Diff</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">objectish</span>, <span class="ruby-identifier">obj2</span>)
     <span class="ruby-keyword kw">end</span>
@@ -629,21 +764,28 @@ Chacon&#8217; g.config # returns whole config hash
         </div>
       </div>
 
-      <div id="method-M000082" class="method-detail">
-        <a name="M000082"></a>
+      <div id="method-M000094" class="method-detail">
+        <a name="M000094"></a>
 
         <div class="method-heading">
-          <a href="#M000082" class="method-signature">
+          <a href="#M000094" class="method-signature">
           <span class="method-name">dir</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+returns a reference to the working directory
+</p>
+<pre>
+ @git.dir.path
+ @git.dir.writeable?
+</pre>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000082-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000082-source">
+            onclick="toggleCode('M000094-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000094-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 75</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 80</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dir</span>
       <span class="ruby-ivar">@working_directory</span>
     <span class="ruby-keyword kw">end</span>
@@ -652,21 +794,25 @@ Chacon&#8217; g.config # returns whole config hash
         </div>
       </div>
 
-      <div id="method-M000107" class="method-detail">
-        <a name="M000107"></a>
+      <div id="method-M000121" class="method-detail">
+        <a name="M000121"></a>
 
         <div class="method-heading">
-          <a href="#M000107" class="method-signature">
+          <a href="#M000121" class="method-signature">
           <span class="method-name">fetch</span><span class="method-args">(remote = 'origin')</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+fetches changes from a remote branch - this does not modify the working
+directory, it just gets the changes from the remote if there are any
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000107-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000107-source">
+            onclick="toggleCode('M000121-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000121-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 192</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 274</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">remote</span> = <span class="ruby-value str">'origin'</span>)
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">remote</span>)
     <span class="ruby-keyword kw">end</span>
@@ -675,49 +821,95 @@ Chacon&#8217; g.config # returns whole config hash
         </div>
       </div>
 
-      <div id="method-M000091" class="method-detail">
-        <a name="M000091"></a>
+      <div id="method-M000105" class="method-detail">
+        <a name="M000105"></a>
 
         <div class="method-heading">
+          <a href="#M000105" class="method-signature">
           <span class="method-name">gblob</span><span class="method-args">(objectish)</span>
+          </a>
         </div>
       
         <div class="method-description">
-          <p>
-Alias for <a href="Base.html#M000088">object</a>
-</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000105-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000105-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 169</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">gblob</span>(<span class="ruby-identifier">objectish</span>)
+      <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Object</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">objectish</span>, <span class="ruby-value str">'blob'</span>)
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
         </div>
       </div>
 
-      <div id="method-M000090" class="method-detail">
-        <a name="M000090"></a>
+      <div id="method-M000104" class="method-detail">
+        <a name="M000104"></a>
 
         <div class="method-heading">
+          <a href="#M000104" class="method-signature">
           <span class="method-name">gcommit</span><span class="method-args">(objectish)</span>
+          </a>
         </div>
       
         <div class="method-description">
-          <p>
-Alias for <a href="Base.html#M000088">object</a>
-</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000104-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000104-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 165</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">gcommit</span>(<span class="ruby-identifier">objectish</span>)
+      <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Object</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">objectish</span>, <span class="ruby-value str">'commit'</span>)
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
         </div>
       </div>
 
-      <div id="method-M000098" class="method-detail">
-        <a name="M000098"></a>
+      <div id="method-M000112" class="method-detail">
+        <a name="M000112"></a>
 
         <div class="method-heading">
-          <a href="#M000098" class="method-signature">
+          <a href="#M000112" class="method-signature">
           <span class="method-name">grep</span><span class="method-args">(string)</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+will run a grep for &#8216;string&#8217; on the HEAD of the git repository
+</p>
+<p>
+to be more surgical in your grep, you can call grep() off a specific git
+object. for example:
+</p>
+<pre>
+ @git.object(&quot;v2.3&quot;).grep('TODO')
+</pre>
+<p>
+in any case, it returns a hash of arrays of the type:
+</p>
+<pre>
+ hsh[tree-ish] = [[line_no, match], [line_no, match2]]
+ hsh[tree-ish] = [[line_no, match], [line_no, match2]]
+</pre>
+<p>
+so you might use it like this:
+</p>
+<pre>
+  @git.grep(&quot;TODO&quot;).each do |sha, arr|
+    puts &quot;in blob #{sha}:&quot;
+    arr.each do |match|
+      puts &quot;\t line #{match[0]}: '#{match[1]}'&quot;
+    end
+  end
+</pre>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000098-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000098-source">
+            onclick="toggleCode('M000112-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000112-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 153</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 224</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">grep</span>(<span class="ruby-identifier">string</span>)
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">object</span>(<span class="ruby-value str">'HEAD'</span>).<span class="ruby-identifier">grep</span>(<span class="ruby-identifier">string</span>)
     <span class="ruby-keyword kw">end</span>
@@ -726,35 +918,47 @@ Alias for <a href="Base.html#M000088">object</a>
         </div>
       </div>
 
-      <div id="method-M000089" class="method-detail">
-        <a name="M000089"></a>
+      <div id="method-M000103" class="method-detail">
+        <a name="M000103"></a>
 
         <div class="method-heading">
+          <a href="#M000103" class="method-signature">
           <span class="method-name">gtree</span><span class="method-args">(objectish)</span>
+          </a>
         </div>
       
         <div class="method-description">
-          <p>
-Alias for <a href="Base.html#M000088">object</a>
-</p>
-        </div>
-      </div>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000103-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000103-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 161</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">gtree</span>(<span class="ruby-identifier">objectish</span>)
+      <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Object</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">objectish</span>, <span class="ruby-value str">'tree'</span>)
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
 
-      <div id="method-M000084" class="method-detail">
-        <a name="M000084"></a>
+      <div id="method-M000096" class="method-detail">
+        <a name="M000096"></a>
 
         <div class="method-heading">
-          <a href="#M000084" class="method-signature">
+          <a href="#M000096" class="method-signature">
           <span class="method-name">index</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+returns reference to the git index file
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000084-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000084-source">
+            onclick="toggleCode('M000096-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000096-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 83</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 91</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">index</span>
       <span class="ruby-ivar">@index</span>
     <span class="ruby-keyword kw">end</span>
@@ -763,44 +967,53 @@ Alias for <a href="Base.html#M000088">object</a>
         </div>
       </div>
 
-      <div id="method-M000097" class="method-detail">
-        <a name="M000097"></a>
+      <div id="method-M000111" class="method-detail">
+        <a name="M000111"></a>
 
         <div class="method-heading">
-          <a href="#M000097" class="method-signature">
+          <a href="#M000111" class="method-signature">
           <span class="method-name">lib</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+this is a convenience method for accessing the class that wraps all the
+actual &#8216;git&#8217; forked system calls. At some point I hope to
+replace the <a href="Lib.html">Git::Lib</a> class with one that uses native
+methods or libgit C bindings
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000097-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000097-source">
+            onclick="toggleCode('M000111-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000111-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 149</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 201</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">lib</span>
-      <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Lib</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>)
+      <span class="ruby-ivar">@lib</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Lib</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>)
     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>
       </div>
 
-      <div id="method-M000092" class="method-detail">
-        <a name="M000092"></a>
+      <div id="method-M000106" class="method-detail">
+        <a name="M000106"></a>
 
         <div class="method-heading">
-          <a href="#M000092" class="method-signature">
+          <a href="#M000106" class="method-signature">
           <span class="method-name">log</span><span class="method-args">(count = 30)</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+returns a <a href="Log.html">Git::Log</a> object with count commits
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000092-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000092-source">
+            onclick="toggleCode('M000106-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000106-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 128</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 174</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">count</span> = <span class="ruby-value">30</span>)
       <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Log</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">count</span>)
     <span class="ruby-keyword kw">end</span>
@@ -809,21 +1022,51 @@ Alias for <a href="Base.html#M000088">object</a>
         </div>
       </div>
 
-      <div id="method-M000109" class="method-detail">
-        <a name="M000109"></a>
+      <div id="method-M000140" class="method-detail">
+        <a name="M000140"></a>
 
         <div class="method-heading">
-          <a href="#M000109" class="method-signature">
+          <a href="#M000140" class="method-signature">
+          <span class="method-name">ls_files</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000140-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000140-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 390</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ls_files</span>
+      <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">ls_files</span>
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000123" class="method-detail">
+        <a name="M000123"></a>
+
+        <div class="method-heading">
+          <a href="#M000123" class="method-signature">
           <span class="method-name">merge</span><span class="method-args">(branch, message = 'merge')</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+merges one or more branches into the current working branch
+</p>
+<p>
+you can specify more than one branch to merge by passing an array of
+branches
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000109-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000109-source">
+            onclick="toggleCode('M000123-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000123-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 200</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 290</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">merge</span>(<span class="ruby-identifier">branch</span>, <span class="ruby-identifier">message</span> = <span class="ruby-value str">'merge'</span>)
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">branch</span>, <span class="ruby-identifier">message</span>)
     <span class="ruby-keyword kw">end</span>
@@ -832,24 +1075,32 @@ Alias for <a href="Base.html#M000088">object</a>
         </div>
       </div>
 
-      <div id="method-M000088" class="method-detail">
-        <a name="M000088"></a>
+      <div id="method-M000102" class="method-detail">
+        <a name="M000102"></a>
 
         <div class="method-heading">
-          <a href="#M000088" class="method-signature">
+          <a href="#M000102" class="method-signature">
           <span class="method-name">object</span><span class="method-args">(objectish)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
-factory methods
+returns a <a href="Object.html">Git::Object</a> of the appropriate type you
+can also call @git.gtree(&#8216;tree&#8217;), but that&#8217;s just for
+readability. If you call @git.gtree(&#8216;HEAD&#8217;) it will still
+return a <a href="Object/Commit.html">Git::Object::Commit</a> object.
+</p>
+<p>
+@git.object calls a factory method that will run a rev-parse on the
+objectish and determine the type of the object and return an appropriate
+object for that type
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000088-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000088-source">
+            onclick="toggleCode('M000102-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000102-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 120</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 157</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">object</span>(<span class="ruby-identifier">objectish</span>)
       <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Object</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">objectish</span>)
     <span class="ruby-keyword kw">end</span>
@@ -858,21 +1109,25 @@ factory methods
         </div>
       </div>
 
-      <div id="method-M000110" class="method-detail">
-        <a name="M000110"></a>
+      <div id="method-M000124" class="method-detail">
+        <a name="M000124"></a>
 
         <div class="method-heading">
-          <a href="#M000110" class="method-signature">
+          <a href="#M000124" class="method-signature">
           <span class="method-name">pull</span><span class="method-args">(remote = 'origin', branch = 'master', message = 'origin pull')</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+fetches a branch from a remote and merges it into the current working
+branch
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000110-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000110-source">
+            onclick="toggleCode('M000124-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000124-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 204</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 295</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pull</span>(<span class="ruby-identifier">remote</span> = <span class="ruby-value str">'origin'</span>, <span class="ruby-identifier">branch</span> = <span class="ruby-value str">'master'</span>, <span class="ruby-identifier">message</span> = <span class="ruby-value str">'origin pull'</span>)
       <span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">remote</span>)
       <span class="ruby-identifier">merge</span>(<span class="ruby-identifier">branch</span>, <span class="ruby-identifier">message</span>)
@@ -882,21 +1137,29 @@ factory methods
         </div>
       </div>
 
-      <div id="method-M000108" class="method-detail">
-        <a name="M000108"></a>
+      <div id="method-M000122" class="method-detail">
+        <a name="M000122"></a>
 
         <div class="method-heading">
-          <a href="#M000108" class="method-signature">
+          <a href="#M000122" class="method-signature">
           <span class="method-name">push</span><span class="method-args">(remote = 'origin', branch = 'master')</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+pushes changes to a remote repository - easiest if this is a cloned
+repository, otherwise you may have to run something like this first to
+setup the push parameters:
+</p>
+<pre>
+ @git.config('remote.remote-name.push', 'refs/heads/master:refs/heads/master')
+</pre>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000108-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000108-source">
+            onclick="toggleCode('M000122-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000122-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 196</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 283</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">push</span>(<span class="ruby-identifier">remote</span> = <span class="ruby-value str">'origin'</span>, <span class="ruby-identifier">branch</span> = <span class="ruby-value str">'master'</span>)
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">remote</span>, <span class="ruby-identifier">branch</span>)
     <span class="ruby-keyword kw">end</span>
@@ -905,21 +1168,47 @@ factory methods
         </div>
       </div>
 
-      <div id="method-M000096" class="method-detail">
-        <a name="M000096"></a>
+      <div id="method-M000135" class="method-detail">
+        <a name="M000135"></a>
 
         <div class="method-heading">
-          <a href="#M000096" class="method-signature">
+          <a href="#M000135" class="method-signature">
+          <span class="method-name">read_tree</span><span class="method-args">(treeish, opts = {})</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000135-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000135-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 368</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read_tree</span>(<span class="ruby-identifier">treeish</span>, <span class="ruby-identifier">opts</span> = {})
+      <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">read_tree</span>(<span class="ruby-identifier">treeish</span>, <span class="ruby-identifier">opts</span>)
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000110" class="method-detail">
+        <a name="M000110"></a>
+
+        <div class="method-heading">
+          <a href="#M000110" class="method-signature">
           <span class="method-name">remote</span><span class="method-args">(remote_name = 'origin')</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+returns a <a href="Remote.html">Git::Remote</a> object
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000096-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000096-source">
+            onclick="toggleCode('M000110-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000110-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 144</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 194</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">remote</span>(<span class="ruby-identifier">remote_name</span> = <span class="ruby-value str">'origin'</span>)
       <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Remote</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">remote_name</span>)
     <span class="ruby-keyword kw">end</span>
@@ -928,21 +1217,25 @@ factory methods
         </div>
       </div>
 
-      <div id="method-M000111" class="method-detail">
-        <a name="M000111"></a>
+      <div id="method-M000125" class="method-detail">
+        <a name="M000125"></a>
 
         <div class="method-heading">
-          <a href="#M000111" class="method-signature">
+          <a href="#M000125" class="method-signature">
           <span class="method-name">remotes</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+returns an array of <a href="../Git.html">Git</a>:<a
+href="Remote.html">Remote</a> objects
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000111-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000111-source">
+            onclick="toggleCode('M000125-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000125-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 209</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 301</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">remotes</span>
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">remotes</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">r</span><span class="ruby-operator">|</span> <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Remote</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">r</span>) }
     <span class="ruby-keyword kw">end</span>
@@ -951,21 +1244,24 @@ factory methods
         </div>
       </div>
 
-      <div id="method-M000101" class="method-detail">
-        <a name="M000101"></a>
+      <div id="method-M000115" class="method-detail">
+        <a name="M000115"></a>
 
         <div class="method-heading">
-          <a href="#M000101" class="method-signature">
+          <a href="#M000115" class="method-signature">
           <span class="method-name">remove</span><span class="method-args">(path = '.', opts = {})</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+removes file(s) from the git repository
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000101-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000101-source">
+            onclick="toggleCode('M000115-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000115-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 166</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 239</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">remove</span>(<span class="ruby-identifier">path</span> = <span class="ruby-value str">'.'</span>, <span class="ruby-identifier">opts</span> = {})
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">remove</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">opts</span>)
     <span class="ruby-keyword kw">end</span>
@@ -974,24 +1270,24 @@ factory methods
         </div>
       </div>
 
-      <div id="method-M000116" class="method-detail">
-        <a name="M000116"></a>
+      <div id="method-M000131" class="method-detail">
+        <a name="M000131"></a>
 
         <div class="method-heading">
-          <a href="#M000116" class="method-signature">
+          <a href="#M000131" class="method-signature">
           <span class="method-name">repack</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
-convenience methods
+repacks the repository
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000116-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000116-source">
+            onclick="toggleCode('M000131-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000131-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 236</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 342</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">repack</span>
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">repack</span>
     <span class="ruby-keyword kw">end</span>
@@ -1000,21 +1296,27 @@ convenience methods
         </div>
       </div>
 
-      <div id="method-M000083" class="method-detail">
-        <a name="M000083"></a>
+      <div id="method-M000095" class="method-detail">
+        <a name="M000095"></a>
 
         <div class="method-heading">
-          <a href="#M000083" class="method-signature">
+          <a href="#M000095" class="method-signature">
           <span class="method-name">repo</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+returns reference to the git repository directory
+</p>
+<pre>
+ @git.dir.path
+</pre>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000083-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000083-source">
+            onclick="toggleCode('M000095-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000095-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 79</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 86</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">repo</span>
       <span class="ruby-ivar">@repository</span>
     <span class="ruby-keyword kw">end</span>
@@ -1023,21 +1325,24 @@ convenience methods
         </div>
       </div>
 
-      <div id="method-M000086" class="method-detail">
-        <a name="M000086"></a>
+      <div id="method-M000100" class="method-detail">
+        <a name="M000100"></a>
 
         <div class="method-heading">
-          <a href="#M000086" class="method-signature">
+          <a href="#M000100" class="method-signature">
           <span class="method-name">repo_size</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+returns the repository size in bytes
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000086-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000086-source">
+            onclick="toggleCode('M000100-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000100-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 93</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 122</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">repo_size</span>
       <span class="ruby-identifier">size</span> = <span class="ruby-value">0</span>
       <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span>(<span class="ruby-identifier">repo</span>.<span class="ruby-identifier">path</span>) <span class="ruby-keyword kw">do</span>
@@ -1050,21 +1355,24 @@ convenience methods
         </div>
       </div>
 
-      <div id="method-M000102" class="method-detail">
-        <a name="M000102"></a>
+      <div id="method-M000116" class="method-detail">
+        <a name="M000116"></a>
 
         <div class="method-heading">
-          <a href="#M000102" class="method-signature">
+          <a href="#M000116" class="method-signature">
           <span class="method-name">reset</span><span class="method-args">(commitish = nil, opts = {})</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+resets the working directory to the provided commitish
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000102-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000102-source">
+            onclick="toggleCode('M000116-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000116-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 170</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 244</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset</span>(<span class="ruby-identifier">commitish</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">opts</span> = {})
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">reset</span>(<span class="ruby-identifier">commitish</span>, <span class="ruby-identifier">opts</span>)
     <span class="ruby-keyword kw">end</span>
@@ -1073,21 +1381,25 @@ convenience methods
         </div>
       </div>
 
-      <div id="method-M000103" class="method-detail">
-        <a name="M000103"></a>
+      <div id="method-M000117" class="method-detail">
+        <a name="M000117"></a>
 
         <div class="method-heading">
-          <a href="#M000103" class="method-signature">
+          <a href="#M000117" class="method-signature">
           <span class="method-name">reset_hard</span><span class="method-args">(commitish = nil, opts = {})</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+resets the working directory to the commitish with
+&#8217;&#8212;hard&#8217;
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000103-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000103-source">
+            onclick="toggleCode('M000117-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000117-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 174</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 249</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset_hard</span>(<span class="ruby-identifier">commitish</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">opts</span> = {})
       <span class="ruby-identifier">opts</span> = {<span class="ruby-identifier">:hard</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">true</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">opts</span>)
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">reset</span>(<span class="ruby-identifier">commitish</span>, <span class="ruby-identifier">opts</span>)
@@ -1097,21 +1409,29 @@ convenience methods
         </div>
       </div>
 
-      <div id="method-M000117" class="method-detail">
-        <a name="M000117"></a>
+      <div id="method-M000143" class="method-detail">
+        <a name="M000143"></a>
 
         <div class="method-heading">
-          <a href="#M000117" class="method-signature">
+          <a href="#M000143" class="method-signature">
           <span class="method-name">revparse</span><span class="method-args">(objectish)</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+runs git rev-parse to convert the objectish to a full sha
+</p>
+<pre>
+  @git.revparse(&quot;HEAD^^&quot;)
+  @git.revparse('v2.4^{tree}')
+  @git.revparse('v2.4:/doc/index.html')
+</pre>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000117-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000117-source">
+            onclick="toggleCode('M000143-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000143-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 240</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 420</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">revparse</span>(<span class="ruby-identifier">objectish</span>)
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">revparse</span>(<span class="ruby-identifier">objectish</span>)
     <span class="ruby-keyword kw">end</span>
@@ -1120,21 +1440,72 @@ convenience methods
         </div>
       </div>
 
-      <div id="method-M000093" class="method-detail">
-        <a name="M000093"></a>
+      <div id="method-M000098" class="method-detail">
+        <a name="M000098"></a>
 
         <div class="method-heading">
-          <a href="#M000093" class="method-signature">
+          <a href="#M000098" class="method-signature">
+          <span class="method-name">set_index</span><span class="method-args">(index_file, check = true)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000098-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000098-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 101</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_index</span>(<span class="ruby-identifier">index_file</span>, <span class="ruby-identifier">check</span> = <span class="ruby-keyword kw">true</span>)
+      <span class="ruby-ivar">@lib</span> = <span class="ruby-keyword kw">nil</span>
+      <span class="ruby-ivar">@index</span> = <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Index</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">index_file</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">check</span>)
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000097" class="method-detail">
+        <a name="M000097"></a>
+
+        <div class="method-heading">
+          <a href="#M000097" class="method-signature">
+          <span class="method-name">set_working</span><span class="method-args">(work_dir, check = true)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000097-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000097-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 96</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_working</span>(<span class="ruby-identifier">work_dir</span>, <span class="ruby-identifier">check</span> = <span class="ruby-keyword kw">true</span>)
+      <span class="ruby-ivar">@lib</span> = <span class="ruby-keyword kw">nil</span>
+      <span class="ruby-ivar">@working_directory</span> = <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">WorkingDirectory</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">work_dir</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">check</span>)
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000107" class="method-detail">
+        <a name="M000107"></a>
+
+        <div class="method-heading">
+          <a href="#M000107" class="method-signature">
           <span class="method-name">status</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+returns a <a href="Status.html">Git::Status</a> object
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000093-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000093-source">
+            onclick="toggleCode('M000107-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000107-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 132</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 179</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">status</span>
       <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Status</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>)
     <span class="ruby-keyword kw">end</span>
@@ -1143,44 +1514,50 @@ convenience methods
         </div>
       </div>
 
-      <div id="method-M000114" class="method-detail">
-        <a name="M000114"></a>
+      <div id="method-M000128" class="method-detail">
+        <a name="M000128"></a>
 
         <div class="method-heading">
-          <a href="#M000114" class="method-signature">
+          <a href="#M000128" class="method-signature">
           <span class="method-name">tag</span><span class="method-args">(tag_name)</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+returns a Git::Tag object
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000114-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000114-source">
+            onclick="toggleCode('M000128-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000128-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 225</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 326</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">tag</span>(<span class="ruby-identifier">tag_name</span>)
-      <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Object</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">tag_name</span>, <span class="ruby-keyword kw">true</span>)
+      <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Object</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">tag_name</span>, <span class="ruby-value str">'tag'</span>, <span class="ruby-keyword kw">true</span>)
     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>
       </div>
 
-      <div id="method-M000113" class="method-detail">
-        <a name="M000113"></a>
+      <div id="method-M000127" class="method-detail">
+        <a name="M000127"></a>
 
         <div class="method-heading">
-          <a href="#M000113" class="method-signature">
+          <a href="#M000127" class="method-signature">
           <span class="method-name">tags</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
+          <p>
+returns an array of all Git::Tag objects for this repository
+</p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000113-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000113-source">
+            onclick="toggleCode('M000127-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000127-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/git/base.rb, line 221</span>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 321</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">tags</span>
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">tags</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">r</span><span class="ruby-operator">|</span> <span class="ruby-identifier">tag</span>(<span class="ruby-identifier">r</span>) }
     <span class="ruby-keyword kw">end</span>
@@ -1189,6 +1566,189 @@ convenience methods
         </div>
       </div>
 
+      <div id="method-M000139" class="method-detail">
+        <a name="M000139"></a>
+
+        <div class="method-heading">
+          <a href="#M000139" class="method-signature">
+          <span class="method-name">update_ref</span><span class="method-args">(branch, commit)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000139-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000139-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 385</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">update_ref</span>(<span class="ruby-identifier">branch</span>, <span class="ruby-identifier">commit</span>)
+      <span class="ruby-identifier">branch</span>(<span class="ruby-identifier">branch</span>).<span class="ruby-identifier">update_ref</span>(<span class="ruby-identifier">commit</span>)
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000132" class="method-detail">
+        <a name="M000132"></a>
+
+        <div class="method-heading">
+          <a href="#M000132" class="method-signature">
+          <span class="method-name">with_index</span><span class="method-args">(new_index) {|@index| ...}</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+LOWER LEVEL INDEX OPERATIONS ##
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000132-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000132-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 349</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">with_index</span>(<span class="ruby-identifier">new_index</span>)
+      <span class="ruby-identifier">old_index</span> = <span class="ruby-ivar">@index</span>
+      <span class="ruby-identifier">set_index</span>(<span class="ruby-identifier">new_index</span>, <span class="ruby-keyword kw">false</span>)
+      <span class="ruby-identifier">return_value</span> = <span class="ruby-keyword kw">yield</span> <span class="ruby-ivar">@index</span>
+      <span class="ruby-identifier">set_index</span>(<span class="ruby-identifier">old_index</span>)
+      <span class="ruby-identifier">return_value</span>
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000133" class="method-detail">
+        <a name="M000133"></a>
+
+        <div class="method-heading">
+          <a href="#M000133" class="method-signature">
+          <span class="method-name">with_temp_index</span><span class="method-args">(&amp;blk)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000133-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000133-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 357</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">with_temp_index</span> <span class="ruby-operator">&amp;</span><span class="ruby-identifier">blk</span>
+      <span class="ruby-identifier">tempfile</span> = <span class="ruby-constant">Tempfile</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'temp-index'</span>)
+      <span class="ruby-identifier">temp_path</span> = <span class="ruby-identifier">tempfile</span>.<span class="ruby-identifier">path</span>
+      <span class="ruby-identifier">tempfile</span>.<span class="ruby-identifier">unlink</span>
+      <span class="ruby-identifier">with_index</span>(<span class="ruby-identifier">temp_path</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">blk</span>)
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000142" class="method-detail">
+        <a name="M000142"></a>
+
+        <div class="method-heading">
+          <a href="#M000142" class="method-signature">
+          <span class="method-name">with_temp_working</span><span class="method-args">(&amp;blk)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000142-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000142-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 405</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">with_temp_working</span> <span class="ruby-operator">&amp;</span><span class="ruby-identifier">blk</span>
+      <span class="ruby-identifier">tempfile</span> = <span class="ruby-constant">Tempfile</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">&quot;temp-workdir&quot;</span>)
+      <span class="ruby-identifier">temp_dir</span> = <span class="ruby-identifier">tempfile</span>.<span class="ruby-identifier">path</span>
+      <span class="ruby-identifier">tempfile</span>.<span class="ruby-identifier">unlink</span>
+      <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">mkdir</span>(<span class="ruby-identifier">temp_dir</span>, <span class="ruby-value">0700</span>)
+      <span class="ruby-identifier">with_working</span>(<span class="ruby-identifier">temp_dir</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">blk</span>)
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000141" class="method-detail">
+        <a name="M000141"></a>
+
+        <div class="method-heading">
+          <a href="#M000141" class="method-signature">
+          <span class="method-name">with_working</span><span class="method-args">(work_dir) {|@working_directory| ...}</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000141-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000141-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 394</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">with_working</span>(<span class="ruby-identifier">work_dir</span>)
+      <span class="ruby-identifier">return_value</span> = <span class="ruby-keyword kw">false</span>
+      <span class="ruby-identifier">old_working</span> = <span class="ruby-ivar">@working_directory</span>
+      <span class="ruby-identifier">set_working</span>(<span class="ruby-identifier">work_dir</span>) 
+      <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span> <span class="ruby-identifier">work_dir</span> <span class="ruby-keyword kw">do</span>
+        <span class="ruby-identifier">return_value</span> = <span class="ruby-keyword kw">yield</span> <span class="ruby-ivar">@working_directory</span>
+      <span class="ruby-keyword kw">end</span>
+      <span class="ruby-identifier">set_working</span>(<span class="ruby-identifier">old_working</span>)
+      <span class="ruby-identifier">return_value</span>
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000138" class="method-detail">
+        <a name="M000138"></a>
+
+        <div class="method-heading">
+          <a href="#M000138" class="method-signature">
+          <span class="method-name">write_and_commit_tree</span><span class="method-args">(opts = {})</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000138-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000138-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 380</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">write_and_commit_tree</span>(<span class="ruby-identifier">opts</span> = {})
+      <span class="ruby-identifier">tree</span> = <span class="ruby-identifier">write_tree</span>
+      <span class="ruby-identifier">commit_tree</span>(<span class="ruby-identifier">tree</span>, <span class="ruby-identifier">opts</span>)
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000136" class="method-detail">
+        <a name="M000136"></a>
+
+        <div class="method-heading">
+          <a href="#M000136" class="method-signature">
+          <span class="method-name">write_tree</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000136-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000136-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/git/base.rb, line 372</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">write_tree</span>
+      <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">write_tree</span>
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
 
     </div>