doc/classes/Git/Base.html

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE html
   3      PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   4      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   5
   6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   7 <head>
   8   <title>Class: Git::Base</title>
   9   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  10   <meta http-equiv="Content-Script-Type" content="text/javascript" />
  11   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
  12   <script type="text/javascript">
  13   // <![CDATA[
  14
  15   function popupCode( url ) {
  16     window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  17   }
  18
  19   function toggleCode( id ) {
  20     if ( document.getElementById )
  21       elem = document.getElementById( id );
  22     else if ( document.all )
  23       elem = eval( "document.all." + id );
  24     else
  25       return false;
  26
  27     elemStyle = elem.style;
  28
  29     if ( elemStyle.display != "block" ) {
  30       elemStyle.display = "block"
  31     } else {
  32       elemStyle.display = "none"
  33     }
  34
  35     return true;
  36   }
  37
  38   // Make codeblocks hidden by default
  39   document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  40
  41   // ]]>
  42   </script>
  43
  44 </head>
  45 <body>
  46
  47
  48
  49     <div id="classHeader">
  50         <table class="header-table">
  51         <tr class="top-aligned-row">
  52           <td><strong>Class</strong></td>
  53           <td class="class-name-in-header">Git::Base</td>
  54         </tr>
  55         <tr class="top-aligned-row">
  56             <td><strong>In:</strong></td>
  57             <td>
  58                 <a href="../../files/lib/git/base_rb.html">
  59                 lib/git/base.rb
  60                 </a>
  61         <br />
  62             </td>
  63         </tr>
  64
  65         <tr class="top-aligned-row">
  66             <td><strong>Parent:</strong></td>
  67             <td>
  68                 <a href="Object.html">
  69                 Object
  70                </a>
  71             </td>
  72         </tr>
  73         </table>
  74     </div>
  75   <!-- banner header -->
  76
  77   <div id="bodyContent">
  78
  79
  80
  81   <div id="contextContent">
  82
  83
  84
  85    </div>
  86
  87     <div id="method-list">
  88       <h3 class="section-bar">Methods</h3>
  89
  90       <div class="name-list">
  91       <a href="#M000114">add</a>&nbsp;&nbsp;
  92       <a href="#M000126">add_remote</a>&nbsp;&nbsp;
  93       <a href="#M000129">add_tag</a>&nbsp;&nbsp;
  94       <a href="#M000130">archive</a>&nbsp;&nbsp;
  95       <a href="#M000089">bare</a>&nbsp;&nbsp;
  96       <a href="#M000109">branch</a>&nbsp;&nbsp;
  97       <a href="#M000108">branches</a>&nbsp;&nbsp;
  98       <a href="#M000099">chdir</a>&nbsp;&nbsp;
  99       <a href="#M000120">checkout</a>&nbsp;&nbsp;
 100       <a href="#M000134">checkout_index</a>&nbsp;&nbsp;
 101       <a href="#M000092">clone</a>&nbsp;&nbsp;
 102       <a href="#M000118">commit</a>&nbsp;&nbsp;
 103       <a href="#M000119">commit_all</a>&nbsp;&nbsp;
 104       <a href="#M000137">commit_tree</a>&nbsp;&nbsp;
 105       <a href="#M000101">config</a>&nbsp;&nbsp;
 106       <a href="#M000144">current_branch</a>&nbsp;&nbsp;
 107       <a href="#M000113">diff</a>&nbsp;&nbsp;
 108       <a href="#M000094">dir</a>&nbsp;&nbsp;
 109       <a href="#M000121">fetch</a>&nbsp;&nbsp;
 110       <a href="#M000105">gblob</a>&nbsp;&nbsp;
 111       <a href="#M000104">gcommit</a>&nbsp;&nbsp;
 112       <a href="#M000112">grep</a>&nbsp;&nbsp;
 113       <a href="#M000103">gtree</a>&nbsp;&nbsp;
 114       <a href="#M000096">index</a>&nbsp;&nbsp;
 115       <a href="#M000091">init</a>&nbsp;&nbsp;
 116       <a href="#M000111">lib</a>&nbsp;&nbsp;
 117       <a href="#M000106">log</a>&nbsp;&nbsp;
 118       <a href="#M000140">ls_files</a>&nbsp;&nbsp;
 119       <a href="#M000123">merge</a>&nbsp;&nbsp;
 120       <a href="#M000093">new</a>&nbsp;&nbsp;
 121       <a href="#M000102">object</a>&nbsp;&nbsp;
 122       <a href="#M000090">open</a>&nbsp;&nbsp;
 123       <a href="#M000124">pull</a>&nbsp;&nbsp;
 124       <a href="#M000122">push</a>&nbsp;&nbsp;
 125       <a href="#M000135">read_tree</a>&nbsp;&nbsp;
 126       <a href="#M000110">remote</a>&nbsp;&nbsp;
 127       <a href="#M000125">remotes</a>&nbsp;&nbsp;
 128       <a href="#M000115">remove</a>&nbsp;&nbsp;
 129       <a href="#M000131">repack</a>&nbsp;&nbsp;
 130       <a href="#M000095">repo</a>&nbsp;&nbsp;
 131       <a href="#M000100">repo_size</a>&nbsp;&nbsp;
 132       <a href="#M000116">reset</a>&nbsp;&nbsp;
 133       <a href="#M000117">reset_hard</a>&nbsp;&nbsp;
 134       <a href="#M000143">revparse</a>&nbsp;&nbsp;
 135       <a href="#M000098">set_index</a>&nbsp;&nbsp;
 136       <a href="#M000097">set_working</a>&nbsp;&nbsp;
 137       <a href="#M000107">status</a>&nbsp;&nbsp;
 138       <a href="#M000128">tag</a>&nbsp;&nbsp;
 139       <a href="#M000127">tags</a>&nbsp;&nbsp;
 140       <a href="#M000139">update_ref</a>&nbsp;&nbsp;
 141       <a href="#M000132">with_index</a>&nbsp;&nbsp;
 142       <a href="#M000133">with_temp_index</a>&nbsp;&nbsp;
 143       <a href="#M000142">with_temp_working</a>&nbsp;&nbsp;
 144       <a href="#M000141">with_working</a>&nbsp;&nbsp;
 145       <a href="#M000138">write_and_commit_tree</a>&nbsp;&nbsp;
 146       <a href="#M000136">write_tree</a>&nbsp;&nbsp;
 147       </div>
 148     </div>
 149
 150   </div>
 151
 152
 153     <!-- if includes -->
 154
 155     <div id="section">
 156
 157
 158
 159
 160
 161
 162
 163
 164     <!-- if method_list -->
 165     <div id="methods">
 166       <h3 class="section-bar">Public Class methods</h3>
 167
 168       <div id="method-M000089" class="method-detail">
 169         <a name="M000089"></a>
 170
 171         <div class="method-heading">
 172           <a href="#M000089" class="method-signature">
 173           <span class="method-name">bare</span><span class="method-args">(git_dir)</span>
 174           </a>
 175         </div>
 176
 177         <div class="method-description">
 178           <p>
 179 opens a bare <a href="../Git.html">Git</a> <a
 180 href="Repository.html">Repository</a> - no working directory options
 181 </p>
 182           <p><a class="source-toggle" href="#"
 183             onclick="toggleCode('M000089-source');return false;">[Source]</a></p>
 184           <div class="method-source-code" id="M000089-source">
 185 <pre>
 186 <span class="ruby-comment cmt"># File lib/git/base.rb, line 12</span>
 187     <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>)
 188       <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>
 189     <span class="ruby-keyword kw">end</span>
 190 </pre>
 191           </div>
 192         </div>
 193       </div>
 194
 195       <div id="method-M000092" class="method-detail">
 196         <a name="M000092"></a>
 197
 198         <div class="method-heading">
 199           <a href="#M000092" class="method-signature">
 200           <span class="method-name">clone</span><span class="method-args">(repository, name, opts = {})</span>
 201           </a>
 202         </div>
 203
 204         <div class="method-description">
 205           <p>
 206 clones a git repository locally
 207 </p>
 208 <pre>
 209  repository - http://repo.or.cz/w/sinatra.git
 210  name - sinatra
 211 </pre>
 212 <p>
 213 options:
 214 </p>
 215 <pre>
 216   :repository
 217
 218    :bare
 219   or
 220    :working_directory
 221    :index_file
 222 </pre>
 223           <p><a class="source-toggle" href="#"
 224             onclick="toggleCode('M000092-source');return false;">[Source]</a></p>
 225           <div class="method-source-code" id="M000092-source">
 226 <pre>
 227 <span class="ruby-comment cmt"># File lib/git/base.rb, line 60</span>
 228     <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> = {})
 229       <span class="ruby-comment cmt"># run git-clone </span>
 230       <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>))
 231     <span class="ruby-keyword kw">end</span>
 232 </pre>
 233           </div>
 234         </div>
 235       </div>
 236
 237       <div id="method-M000091" class="method-detail">
 238         <a name="M000091"></a>
 239
 240         <div class="method-heading">
 241           <a href="#M000091" class="method-signature">
 242           <span class="method-name">init</span><span class="method-args">(working_dir, opts = {})</span>
 243           </a>
 244         </div>
 245
 246         <div class="method-description">
 247           <p>
 248 initializes a git repository
 249 </p>
 250 <p>
 251 options:
 252 </p>
 253 <pre>
 254  :repository
 255  :index_file
 256 </pre>
 257           <p><a class="source-toggle" href="#"
 258             onclick="toggleCode('M000091-source');return false;">[Source]</a></p>
 259           <div class="method-source-code" id="M000091-source">
 260 <pre>
 261 <span class="ruby-comment cmt"># File lib/git/base.rb, line 31</span>
 262     <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> = {})
 263       <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>,
 264                  <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       <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>)
 266
 267       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">git_options</span>[<span class="ruby-identifier">:working_directory</span>]
 268         <span class="ruby-comment cmt"># if !working_dir, make it</span>
 269         <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">git_options</span>[<span class="ruby-identifier">:working_directory</span>]) <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">git_options</span>[<span class="ruby-identifier">:working_directory</span>])
 270       <span class="ruby-keyword kw">end</span>
 271
 272       <span class="ruby-comment cmt"># run git_init there</span>
 273       <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">git_options</span>).<span class="ruby-identifier">init</span>
 274
 275       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">git_options</span>)
 276     <span class="ruby-keyword kw">end</span>
 277 </pre>
 278           </div>
 279         </div>
 280       </div>
 281
 282       <div id="method-M000093" class="method-detail">
 283         <a name="M000093"></a>
 284
 285         <div class="method-heading">
 286           <a href="#M000093" class="method-signature">
 287           <span class="method-name">new</span><span class="method-args">(options = {})</span>
 288           </a>
 289         </div>
 290
 291         <div class="method-description">
 292           <p><a class="source-toggle" href="#"
 293             onclick="toggleCode('M000093-source');return false;">[Source]</a></p>
 294           <div class="method-source-code" id="M000093-source">
 295 <pre>
 296 <span class="ruby-comment cmt"># File lib/git/base.rb, line 65</span>
 297     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">options</span> = {})
 298       <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>]
 299         <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>]
 300         <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:index</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-value str">'index'</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">options</span>[<span class="ruby-identifier">:index</span>]
 301       <span class="ruby-keyword kw">end</span>
 302
 303       <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">options</span>[<span class="ruby-identifier">:working_directory</span>]) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:working_directory</span>]
 304       <span class="ruby-ivar">@repository</span> = <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Repository</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:repository</span>]) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:repository</span>]
 305       <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">options</span>[<span class="ruby-identifier">:index</span>], <span class="ruby-keyword kw">false</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:index</span>]
 306     <span class="ruby-keyword kw">end</span>
 307 </pre>
 308           </div>
 309         </div>
 310       </div>
 311
 312       <div id="method-M000090" class="method-detail">
 313         <a name="M000090"></a>
 314
 315         <div class="method-heading">
 316           <a href="#M000090" class="method-signature">
 317           <span class="method-name">open</span><span class="method-args">(working_dir, opts={})</span>
 318           </a>
 319         </div>
 320
 321         <div class="method-description">
 322           <p>
 323 opens a new <a href="../Git.html">Git</a> Project from a working directory
 324 you can specify non-standard git_dir and index file in the options
 325 </p>
 326           <p><a class="source-toggle" href="#"
 327             onclick="toggleCode('M000090-source');return false;">[Source]</a></p>
 328           <div class="method-source-code" id="M000090-source">
 329 <pre>
 330 <span class="ruby-comment cmt"># File lib/git/base.rb, line 18</span>
 331     <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>={})
 332       <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>}
 333       <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>)
 334
 335       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">git_options</span>)
 336     <span class="ruby-keyword kw">end</span>
 337 </pre>
 338           </div>
 339         </div>
 340       </div>
 341
 342       <h3 class="section-bar">Public Instance methods</h3>
 343
 344       <div id="method-M000114" class="method-detail">
 345         <a name="M000114"></a>
 346
 347         <div class="method-heading">
 348           <a href="#M000114" class="method-signature">
 349           <span class="method-name">add</span><span class="method-args">(path = '.')</span>
 350           </a>
 351         </div>
 352
 353         <div class="method-description">
 354           <p>
 355 adds files from the working directory to the git repository
 356 </p>
 357           <p><a class="source-toggle" href="#"
 358             onclick="toggleCode('M000114-source');return false;">[Source]</a></p>
 359           <div class="method-source-code" id="M000114-source">
 360 <pre>
 361 <span class="ruby-comment cmt"># File lib/git/base.rb, line 234</span>
 362     <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>)
 363       <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>)
 364     <span class="ruby-keyword kw">end</span>
 365 </pre>
 366           </div>
 367         </div>
 368       </div>
 369
 370       <div id="method-M000126" class="method-detail">
 371         <a name="M000126"></a>
 372
 373         <div class="method-heading">
 374           <a href="#M000126" class="method-signature">
 375           <span class="method-name">add_remote</span><span class="method-args">(name, url, opts = {})</span>
 376           </a>
 377         </div>
 378
 379         <div class="method-description">
 380           <p>
 381 adds a new remote to this repository url can be a git url or a <a
 382 href="Base.html">Git::Base</a> object if it&#8217;s a local reference
 383 </p>
 384 <pre>
 385  @git.add_remote('scotts_git', 'git://repo.or.cz/rubygit.git')
 386  @git.fetch('scotts_git')
 387  @git.merge('scotts_git/master')
 388 </pre>
 389           <p><a class="source-toggle" href="#"
 390             onclick="toggleCode('M000126-source');return false;">[Source]</a></p>
 391           <div class="method-source-code" id="M000126-source">
 392 <pre>
 393 <span class="ruby-comment cmt"># File lib/git/base.rb, line 312</span>
 394     <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> = {})
 395       <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>)
 396         <span class="ruby-identifier">url</span> = <span class="ruby-identifier">url</span>.<span class="ruby-identifier">repo</span>.<span class="ruby-identifier">path</span>
 397       <span class="ruby-keyword kw">end</span>
 398       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">remote_add</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">url</span>, <span class="ruby-identifier">opts</span>)
 399       <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">name</span>)
 400     <span class="ruby-keyword kw">end</span>
 401 </pre>
 402           </div>
 403         </div>
 404       </div>
 405
 406       <div id="method-M000129" class="method-detail">
 407         <a name="M000129"></a>
 408
 409         <div class="method-heading">
 410           <a href="#M000129" class="method-signature">
 411           <span class="method-name">add_tag</span><span class="method-args">(tag_name)</span>
 412           </a>
 413         </div>
 414
 415         <div class="method-description">
 416           <p>
 417 creates a new git tag (Git::Tag)
 418 </p>
 419           <p><a class="source-toggle" href="#"
 420             onclick="toggleCode('M000129-source');return false;">[Source]</a></p>
 421           <div class="method-source-code" id="M000129-source">
 422 <pre>
 423 <span class="ruby-comment cmt"># File lib/git/base.rb, line 331</span>
 424     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_tag</span>(<span class="ruby-identifier">tag_name</span>)
 425       <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>)
 426       <span class="ruby-identifier">tag</span>(<span class="ruby-identifier">tag_name</span>)
 427     <span class="ruby-keyword kw">end</span>
 428 </pre>
 429           </div>
 430         </div>
 431       </div>
 432
 433       <div id="method-M000130" class="method-detail">
 434         <a name="M000130"></a>
 435
 436         <div class="method-heading">
 437           <a href="#M000130" class="method-signature">
 438           <span class="method-name">archive</span><span class="method-args">(treeish, file = nil, opts = {})</span>
 439           </a>
 440         </div>
 441
 442         <div class="method-description">
 443           <p>
 444 creates an archive file of the given tree-ish
 445 </p>
 446           <p><a class="source-toggle" href="#"
 447             onclick="toggleCode('M000130-source');return false;">[Source]</a></p>
 448           <div class="method-source-code" id="M000130-source">
 449 <pre>
 450 <span class="ruby-comment cmt"># File lib/git/base.rb, line 337</span>
 451     <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> = {})
 452       <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>)
 453     <span class="ruby-keyword kw">end</span>
 454 </pre>
 455           </div>
 456         </div>
 457       </div>
 458
 459       <div id="method-M000109" class="method-detail">
 460         <a name="M000109"></a>
 461
 462         <div class="method-heading">
 463           <a href="#M000109" class="method-signature">
 464           <span class="method-name">branch</span><span class="method-args">(branch_name = 'master')</span>
 465           </a>
 466         </div>
 467
 468         <div class="method-description">
 469           <p>
 470 returns a <a href="Branch.html">Git::Branch</a> object for branch_name
 471 </p>
 472           <p><a class="source-toggle" href="#"
 473             onclick="toggleCode('M000109-source');return false;">[Source]</a></p>
 474           <div class="method-source-code" id="M000109-source">
 475 <pre>
 476 <span class="ruby-comment cmt"># File lib/git/base.rb, line 189</span>
 477     <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>)
 478       <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>)
 479     <span class="ruby-keyword kw">end</span>
 480 </pre>
 481           </div>
 482         </div>
 483       </div>
 484
 485       <div id="method-M000108" class="method-detail">
 486         <a name="M000108"></a>
 487
 488         <div class="method-heading">
 489           <a href="#M000108" class="method-signature">
 490           <span class="method-name">branches</span><span class="method-args">()</span>
 491           </a>
 492         </div>
 493
 494         <div class="method-description">
 495           <p>
 496 returns a <a href="Branches.html">Git::Branches</a> object of all the <a
 497 href="Branch.html">Git::Branch</a> objects for this repo
 498 </p>
 499           <p><a class="source-toggle" href="#"
 500             onclick="toggleCode('M000108-source');return false;">[Source]</a></p>
 501           <div class="method-source-code" id="M000108-source">
 502 <pre>
 503 <span class="ruby-comment cmt"># File lib/git/base.rb, line 184</span>
 504     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">branches</span>
 505       <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>)
 506     <span class="ruby-keyword kw">end</span>
 507 </pre>
 508           </div>
 509         </div>
 510       </div>
 511
 512       <div id="method-M000099" class="method-detail">
 513         <a name="M000099"></a>
 514
 515         <div class="method-heading">
 516           <a href="#M000099" class="method-signature">
 517           <span class="method-name">chdir</span><span class="method-args">() {|dir.path| ...}</span>
 518           </a>
 519         </div>
 520
 521         <div class="method-description">
 522           <p>
 523 changes current working directory for a block to the git working directory
 524 </p>
 525 <p>
 526 example
 527 </p>
 528 <pre>
 529  @git.chdir do
 530    # write files
 531    @git.add
 532    @git.commit('message')
 533  end
 534 </pre>
 535           <p><a class="source-toggle" href="#"
 536             onclick="toggleCode('M000099-source');return false;">[Source]</a></p>
 537           <div class="method-source-code" id="M000099-source">
 538 <pre>
 539 <span class="ruby-comment cmt"># File lib/git/base.rb, line 115</span>
 540     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">chdir</span>
 541       <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>
 542         <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">dir</span>.<span class="ruby-identifier">path</span>
 543       <span class="ruby-keyword kw">end</span>
 544     <span class="ruby-keyword kw">end</span>
 545 </pre>
 546           </div>
 547         </div>
 548       </div>
 549
 550       <div id="method-M000120" class="method-detail">
 551         <a name="M000120"></a>
 552
 553         <div class="method-heading">
 554           <a href="#M000120" class="method-signature">
 555           <span class="method-name">checkout</span><span class="method-args">(branch = 'master', opts = {})</span>
 556           </a>
 557         </div>
 558
 559         <div class="method-description">
 560           <p>
 561 checks out a branch as the new git working directory
 562 </p>
 563           <p><a class="source-toggle" href="#"
 564             onclick="toggleCode('M000120-source');return false;">[Source]</a></p>
 565           <div class="method-source-code" id="M000120-source">
 566 <pre>
 567 <span class="ruby-comment cmt"># File lib/git/base.rb, line 268</span>
 568     <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> = {})
 569       <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>)
 570     <span class="ruby-keyword kw">end</span>
 571 </pre>
 572           </div>
 573         </div>
 574       </div>
 575
 576       <div id="method-M000134" class="method-detail">
 577         <a name="M000134"></a>
 578
 579         <div class="method-heading">
 580           <a href="#M000134" class="method-signature">
 581           <span class="method-name">checkout_index</span><span class="method-args">(opts = {})</span>
 582           </a>
 583         </div>
 584
 585         <div class="method-description">
 586           <p><a class="source-toggle" href="#"
 587             onclick="toggleCode('M000134-source');return false;">[Source]</a></p>
 588           <div class="method-source-code" id="M000134-source">
 589 <pre>
 590 <span class="ruby-comment cmt"># File lib/git/base.rb, line 364</span>
 591     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">checkout_index</span>(<span class="ruby-identifier">opts</span> = {})
 592       <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>)
 593     <span class="ruby-keyword kw">end</span>
 594 </pre>
 595           </div>
 596         </div>
 597       </div>
 598
 599       <div id="method-M000118" class="method-detail">
 600         <a name="M000118"></a>
 601
 602         <div class="method-heading">
 603           <a href="#M000118" class="method-signature">
 604           <span class="method-name">commit</span><span class="method-args">(message, opts = {})</span>
 605           </a>
 606         </div>
 607
 608         <div class="method-description">
 609           <p>
 610 commits all pending changes in the index file to the git repository
 611 </p>
 612           <p><a class="source-toggle" href="#"
 613             onclick="toggleCode('M000118-source');return false;">[Source]</a></p>
 614           <div class="method-source-code" id="M000118-source">
 615 <pre>
 616 <span class="ruby-comment cmt"># File lib/git/base.rb, line 255</span>
 617     <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> = {})
 618       <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>)
 619     <span class="ruby-keyword kw">end</span>
 620 </pre>
 621           </div>
 622         </div>
 623       </div>
 624
 625       <div id="method-M000119" class="method-detail">
 626         <a name="M000119"></a>
 627
 628         <div class="method-heading">
 629           <a href="#M000119" class="method-signature">
 630           <span class="method-name">commit_all</span><span class="method-args">(message, opts = {})</span>
 631           </a>
 632         </div>
 633
 634         <div class="method-description">
 635           <p>
 636 commits all pending changes in the index file to the git repository, but
 637 automatically adds all modified files without having to explicitly calling
 638 @git.add() on them.
 639 </p>
 640           <p><a class="source-toggle" href="#"
 641             onclick="toggleCode('M000119-source');return false;">[Source]</a></p>
 642           <div class="method-source-code" id="M000119-source">
 643 <pre>
 644 <span class="ruby-comment cmt"># File lib/git/base.rb, line 262</span>
 645     <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> = {})
 646       <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>)
 647       <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>)
 648     <span class="ruby-keyword kw">end</span>
 649 </pre>
 650           </div>
 651         </div>
 652       </div>
 653
 654       <div id="method-M000137" class="method-detail">
 655         <a name="M000137"></a>
 656
 657         <div class="method-heading">
 658           <a href="#M000137" class="method-signature">
 659           <span class="method-name">commit_tree</span><span class="method-args">(tree = nil, opts = {})</span>
 660           </a>
 661         </div>
 662
 663         <div class="method-description">
 664           <p><a class="source-toggle" href="#"
 665             onclick="toggleCode('M000137-source');return false;">[Source]</a></p>
 666           <div class="method-source-code" id="M000137-source">
 667 <pre>
 668 <span class="ruby-comment cmt"># File lib/git/base.rb, line 376</span>
 669     <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> = {})
 670       <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>))
 671     <span class="ruby-keyword kw">end</span>
 672 </pre>
 673           </div>
 674         </div>
 675       </div>
 676
 677       <div id="method-M000101" class="method-detail">
 678         <a name="M000101"></a>
 679
 680         <div class="method-heading">
 681           <a href="#M000101" class="method-signature">
 682           <span class="method-name">config</span><span class="method-args">(name = nil, value = nil)</span>
 683           </a>
 684         </div>
 685
 686         <div class="method-description">
 687           <p>
 688 g.config(&#8216;user.name&#8217;, &#8216;Scott Chacon&#8217;) # sets value
 689 g.config(&#8216;user.email&#8217;, &#8216;email@email.com&#8217;) # sets
 690 value g.config(&#8216;user.name&#8217;) # returns &#8216;Scott
 691 Chacon&#8217; g.config # returns whole config hash
 692 </p>
 693           <p><a class="source-toggle" href="#"
 694             onclick="toggleCode('M000101-source');return false;">[Source]</a></p>
 695           <div class="method-source-code" id="M000101-source">
 696 <pre>
 697 <span class="ruby-comment cmt"># File lib/git/base.rb, line 134</span>
 698     <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>)
 699       <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>)
 700         <span class="ruby-comment cmt"># set value</span>
 701         <span class="ruby-identifier">lib</span>.<span class="ruby-identifier">config_set</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">value</span>)
 702       <span class="ruby-keyword kw">elsif</span> (<span class="ruby-identifier">name</span>)
 703         <span class="ruby-comment cmt"># return value</span>
 704         <span class="ruby-identifier">lib</span>.<span class="ruby-identifier">config_get</span>(<span class="ruby-identifier">name</span>)
 705       <span class="ruby-keyword kw">else</span>
 706         <span class="ruby-comment cmt"># return hash</span>
 707         <span class="ruby-identifier">lib</span>.<span class="ruby-identifier">config_list</span>
 708       <span class="ruby-keyword kw">end</span>
 709     <span class="ruby-keyword kw">end</span>
 710 </pre>
 711           </div>
 712         </div>
 713       </div>
 714
 715       <div id="method-M000144" class="method-detail">
 716         <a name="M000144"></a>
 717
 718         <div class="method-heading">
 719           <a href="#M000144" class="method-signature">
 720           <span class="method-name">current_branch</span><span class="method-args">()</span>
 721           </a>
 722         </div>
 723
 724         <div class="method-description">
 725           <p>
 726 returns the name of the branch the working directory is currently on
 727 </p>
 728           <p><a class="source-toggle" href="#"
 729             onclick="toggleCode('M000144-source');return false;">[Source]</a></p>
 730           <div class="method-source-code" id="M000144-source">
 731 <pre>
 732 <span class="ruby-comment cmt"># File lib/git/base.rb, line 425</span>
 733     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">current_branch</span>
 734       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">branch_current</span>
 735     <span class="ruby-keyword kw">end</span>
 736 </pre>
 737           </div>
 738         </div>
 739       </div>
 740
 741       <div id="method-M000113" class="method-detail">
 742         <a name="M000113"></a>
 743
 744         <div class="method-heading">
 745           <a href="#M000113" class="method-signature">
 746           <span class="method-name">diff</span><span class="method-args">(objectish = 'HEAD', obj2 = nil)</span>
 747           </a>
 748         </div>
 749
 750         <div class="method-description">
 751           <p>
 752 returns a <a href="Diff.html">Git::Diff</a> object
 753 </p>
 754           <p><a class="source-toggle" href="#"
 755             onclick="toggleCode('M000113-source');return false;">[Source]</a></p>
 756           <div class="method-source-code" id="M000113-source">
 757 <pre>
 758 <span class="ruby-comment cmt"># File lib/git/base.rb, line 229</span>
 759     <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>)
 760       <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>)
 761     <span class="ruby-keyword kw">end</span>
 762 </pre>
 763           </div>
 764         </div>
 765       </div>
 766
 767       <div id="method-M000094" class="method-detail">
 768         <a name="M000094"></a>
 769
 770         <div class="method-heading">
 771           <a href="#M000094" class="method-signature">
 772           <span class="method-name">dir</span><span class="method-args">()</span>
 773           </a>
 774         </div>
 775
 776         <div class="method-description">
 777           <p>
 778 returns a reference to the working directory
 779 </p>
 780 <pre>
 781  @git.dir.path
 782  @git.dir.writeable?
 783 </pre>
 784           <p><a class="source-toggle" href="#"
 785             onclick="toggleCode('M000094-source');return false;">[Source]</a></p>
 786           <div class="method-source-code" id="M000094-source">
 787 <pre>
 788 <span class="ruby-comment cmt"># File lib/git/base.rb, line 80</span>
 789     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dir</span>
 790       <span class="ruby-ivar">@working_directory</span>
 791     <span class="ruby-keyword kw">end</span>
 792 </pre>
 793           </div>
 794         </div>
 795       </div>
 796
 797       <div id="method-M000121" class="method-detail">
 798         <a name="M000121"></a>
 799
 800         <div class="method-heading">
 801           <a href="#M000121" class="method-signature">
 802           <span class="method-name">fetch</span><span class="method-args">(remote = 'origin')</span>
 803           </a>
 804         </div>
 805
 806         <div class="method-description">
 807           <p>
 808 fetches changes from a remote branch - this does not modify the working
 809 directory, it just gets the changes from the remote if there are any
 810 </p>
 811           <p><a class="source-toggle" href="#"
 812             onclick="toggleCode('M000121-source');return false;">[Source]</a></p>
 813           <div class="method-source-code" id="M000121-source">
 814 <pre>
 815 <span class="ruby-comment cmt"># File lib/git/base.rb, line 274</span>
 816     <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>)
 817       <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>)
 818     <span class="ruby-keyword kw">end</span>
 819 </pre>
 820           </div>
 821         </div>
 822       </div>
 823
 824       <div id="method-M000105" class="method-detail">
 825         <a name="M000105"></a>
 826
 827         <div class="method-heading">
 828           <a href="#M000105" class="method-signature">
 829           <span class="method-name">gblob</span><span class="method-args">(objectish)</span>
 830           </a>
 831         </div>
 832
 833         <div class="method-description">
 834           <p><a class="source-toggle" href="#"
 835             onclick="toggleCode('M000105-source');return false;">[Source]</a></p>
 836           <div class="method-source-code" id="M000105-source">
 837 <pre>
 838 <span class="ruby-comment cmt"># File lib/git/base.rb, line 169</span>
 839     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">gblob</span>(<span class="ruby-identifier">objectish</span>)
 840       <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>)
 841     <span class="ruby-keyword kw">end</span>
 842 </pre>
 843           </div>
 844         </div>
 845       </div>
 846
 847       <div id="method-M000104" class="method-detail">
 848         <a name="M000104"></a>
 849
 850         <div class="method-heading">
 851           <a href="#M000104" class="method-signature">
 852           <span class="method-name">gcommit</span><span class="method-args">(objectish)</span>
 853           </a>
 854         </div>
 855
 856         <div class="method-description">
 857           <p><a class="source-toggle" href="#"
 858             onclick="toggleCode('M000104-source');return false;">[Source]</a></p>
 859           <div class="method-source-code" id="M000104-source">
 860 <pre>
 861 <span class="ruby-comment cmt"># File lib/git/base.rb, line 165</span>
 862     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">gcommit</span>(<span class="ruby-identifier">objectish</span>)
 863       <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>)
 864     <span class="ruby-keyword kw">end</span>
 865 </pre>
 866           </div>
 867         </div>
 868       </div>
 869
 870       <div id="method-M000112" class="method-detail">
 871         <a name="M000112"></a>
 872
 873         <div class="method-heading">
 874           <a href="#M000112" class="method-signature">
 875           <span class="method-name">grep</span><span class="method-args">(string)</span>
 876           </a>
 877         </div>
 878
 879         <div class="method-description">
 880           <p>
 881 will run a grep for &#8216;string&#8217; on the HEAD of the git repository
 882 </p>
 883 <p>
 884 to be more surgical in your grep, you can call grep() off a specific git
 885 object. for example:
 886 </p>
 887 <pre>
 888  @git.object(&quot;v2.3&quot;).grep('TODO')
 889 </pre>
 890 <p>
 891 in any case, it returns a hash of arrays of the type:
 892 </p>
 893 <pre>
 894  hsh[tree-ish] = [[line_no, match], [line_no, match2]]
 895  hsh[tree-ish] = [[line_no, match], [line_no, match2]]
 896 </pre>
 897 <p>
 898 so you might use it like this:
 899 </p>
 900 <pre>
 901   @git.grep(&quot;TODO&quot;).each do |sha, arr|
 902     puts &quot;in blob #{sha}:&quot;
 903     arr.each do |match|
 904       puts &quot;\t line #{match[0]}: '#{match[1]}'&quot;
 905     end
 906   end
 907 </pre>
 908           <p><a class="source-toggle" href="#"
 909             onclick="toggleCode('M000112-source');return false;">[Source]</a></p>
 910           <div class="method-source-code" id="M000112-source">
 911 <pre>
 912 <span class="ruby-comment cmt"># File lib/git/base.rb, line 224</span>
 913     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">grep</span>(<span class="ruby-identifier">string</span>)
 914       <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>)
 915     <span class="ruby-keyword kw">end</span>
 916 </pre>
 917           </div>
 918         </div>
 919       </div>
 920
 921       <div id="method-M000103" class="method-detail">
 922         <a name="M000103"></a>
 923
 924         <div class="method-heading">
 925           <a href="#M000103" class="method-signature">
 926           <span class="method-name">gtree</span><span class="method-args">(objectish)</span>
 927           </a>
 928         </div>
 929
 930         <div class="method-description">
 931           <p><a class="source-toggle" href="#"
 932             onclick="toggleCode('M000103-source');return false;">[Source]</a></p>
 933           <div class="method-source-code" id="M000103-source">
 934 <pre>
 935 <span class="ruby-comment cmt"># File lib/git/base.rb, line 161</span>
 936     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">gtree</span>(<span class="ruby-identifier">objectish</span>)
 937       <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>)
 938     <span class="ruby-keyword kw">end</span>
 939 </pre>
 940           </div>
 941         </div>
 942       </div>
 943
 944       <div id="method-M000096" class="method-detail">
 945         <a name="M000096"></a>
 946
 947         <div class="method-heading">
 948           <a href="#M000096" class="method-signature">
 949           <span class="method-name">index</span><span class="method-args">()</span>
 950           </a>
 951         </div>
 952
 953         <div class="method-description">
 954           <p>
 955 returns reference to the git index file
 956 </p>
 957           <p><a class="source-toggle" href="#"
 958             onclick="toggleCode('M000096-source');return false;">[Source]</a></p>
 959           <div class="method-source-code" id="M000096-source">
 960 <pre>
 961 <span class="ruby-comment cmt"># File lib/git/base.rb, line 91</span>
 962     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">index</span>
 963       <span class="ruby-ivar">@index</span>
 964     <span class="ruby-keyword kw">end</span>
 965 </pre>
 966           </div>
 967         </div>
 968       </div>
 969
 970       <div id="method-M000111" class="method-detail">
 971         <a name="M000111"></a>
 972
 973         <div class="method-heading">
 974           <a href="#M000111" class="method-signature">
 975           <span class="method-name">lib</span><span class="method-args">()</span>
 976           </a>
 977         </div>
 978
 979         <div class="method-description">
 980           <p>
 981 this is a convenience method for accessing the class that wraps all the
 982 actual &#8216;git&#8217; forked system calls. At some point I hope to
 983 replace the <a href="Lib.html">Git::Lib</a> class with one that uses native
 984 methods or libgit C bindings
 985 </p>
 986           <p><a class="source-toggle" href="#"
 987             onclick="toggleCode('M000111-source');return false;">[Source]</a></p>
 988           <div class="method-source-code" id="M000111-source">
 989 <pre>
 990 <span class="ruby-comment cmt"># File lib/git/base.rb, line 201</span>
 991     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">lib</span>
 992       <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>)
 993     <span class="ruby-keyword kw">end</span>
 994 </pre>
 995           </div>
 996         </div>
 997       </div>
 998
 999       <div id="method-M000106" class="method-detail">
1000         <a name="M000106"></a>
1001
1002         <div class="method-heading">
1003           <a href="#M000106" class="method-signature">
1004           <span class="method-name">log</span><span class="method-args">(count = 30)</span>
1005           </a>
1006         </div>
1007
1008         <div class="method-description">
1009           <p>
1010 returns a <a href="Log.html">Git::Log</a> object with count commits
1011 </p>
1012           <p><a class="source-toggle" href="#"
1013             onclick="toggleCode('M000106-source');return false;">[Source]</a></p>
1014           <div class="method-source-code" id="M000106-source">
1015 <pre>
1016 <span class="ruby-comment cmt"># File lib/git/base.rb, line 174</span>
1017     <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>)
1018       <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>)
1019     <span class="ruby-keyword kw">end</span>
1020 </pre>
1021           </div>
1022         </div>
1023       </div>
1024
1025       <div id="method-M000140" class="method-detail">
1026         <a name="M000140"></a>
1027
1028         <div class="method-heading">
1029           <a href="#M000140" class="method-signature">
1030           <span class="method-name">ls_files</span><span class="method-args">()</span>
1031           </a>
1032         </div>
1033
1034         <div class="method-description">
1035           <p><a class="source-toggle" href="#"
1036             onclick="toggleCode('M000140-source');return false;">[Source]</a></p>
1037           <div class="method-source-code" id="M000140-source">
1038 <pre>
1039 <span class="ruby-comment cmt"># File lib/git/base.rb, line 390</span>
1040     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ls_files</span>
1041       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">ls_files</span>
1042     <span class="ruby-keyword kw">end</span>
1043 </pre>
1044           </div>
1045         </div>
1046       </div>
1047
1048       <div id="method-M000123" class="method-detail">
1049         <a name="M000123"></a>
1050
1051         <div class="method-heading">
1052           <a href="#M000123" class="method-signature">
1053           <span class="method-name">merge</span><span class="method-args">(branch, message = 'merge')</span>
1054           </a>
1055         </div>
1056
1057         <div class="method-description">
1058           <p>
1059 merges one or more branches into the current working branch
1060 </p>
1061 <p>
1062 you can specify more than one branch to merge by passing an array of
1063 branches
1064 </p>
1065           <p><a class="source-toggle" href="#"
1066             onclick="toggleCode('M000123-source');return false;">[Source]</a></p>
1067           <div class="method-source-code" id="M000123-source">
1068 <pre>
1069 <span class="ruby-comment cmt"># File lib/git/base.rb, line 290</span>
1070     <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>)
1071       <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>)
1072     <span class="ruby-keyword kw">end</span>
1073 </pre>
1074           </div>
1075         </div>
1076       </div>
1077
1078       <div id="method-M000102" class="method-detail">
1079         <a name="M000102"></a>
1080
1081         <div class="method-heading">
1082           <a href="#M000102" class="method-signature">
1083           <span class="method-name">object</span><span class="method-args">(objectish)</span>
1084           </a>
1085         </div>
1086
1087         <div class="method-description">
1088           <p>
1089 returns a <a href="Object.html">Git::Object</a> of the appropriate type you
1090 can also call @git.gtree(&#8216;tree&#8217;), but that&#8217;s just for
1091 readability. If you call @git.gtree(&#8216;HEAD&#8217;) it will still
1092 return a <a href="Object/Commit.html">Git::Object::Commit</a> object.
1093 </p>
1094 <p>
1095 @git.object calls a factory method that will run a rev-parse on the
1096 objectish and determine the type of the object and return an appropriate
1097 object for that type
1098 </p>
1099           <p><a class="source-toggle" href="#"
1100             onclick="toggleCode('M000102-source');return false;">[Source]</a></p>
1101           <div class="method-source-code" id="M000102-source">
1102 <pre>
1103 <span class="ruby-comment cmt"># File lib/git/base.rb, line 157</span>
1104     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">object</span>(<span class="ruby-identifier">objectish</span>)
1105       <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>)
1106     <span class="ruby-keyword kw">end</span>
1107 </pre>
1108           </div>
1109         </div>
1110       </div>
1111
1112       <div id="method-M000124" class="method-detail">
1113         <a name="M000124"></a>
1114
1115         <div class="method-heading">
1116           <a href="#M000124" class="method-signature">
1117           <span class="method-name">pull</span><span class="method-args">(remote = 'origin', branch = 'master', message = 'origin pull')</span>
1118           </a>
1119         </div>
1120
1121         <div class="method-description">
1122           <p>
1123 fetches a branch from a remote and merges it into the current working
1124 branch
1125 </p>
1126           <p><a class="source-toggle" href="#"
1127             onclick="toggleCode('M000124-source');return false;">[Source]</a></p>
1128           <div class="method-source-code" id="M000124-source">
1129 <pre>
1130 <span class="ruby-comment cmt"># File lib/git/base.rb, line 295</span>
1131     <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>)
1132       <span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">remote</span>)
1133       <span class="ruby-identifier">merge</span>(<span class="ruby-identifier">branch</span>, <span class="ruby-identifier">message</span>)
1134     <span class="ruby-keyword kw">end</span>
1135 </pre>
1136           </div>
1137         </div>
1138       </div>
1139
1140       <div id="method-M000122" class="method-detail">
1141         <a name="M000122"></a>
1142
1143         <div class="method-heading">
1144           <a href="#M000122" class="method-signature">
1145           <span class="method-name">push</span><span class="method-args">(remote = 'origin', branch = 'master')</span>
1146           </a>
1147         </div>
1148
1149         <div class="method-description">
1150           <p>
1151 pushes changes to a remote repository - easiest if this is a cloned
1152 repository, otherwise you may have to run something like this first to
1153 setup the push parameters:
1154 </p>
1155 <pre>
1156  @git.config('remote.remote-name.push', 'refs/heads/master:refs/heads/master')
1157 </pre>
1158           <p><a class="source-toggle" href="#"
1159             onclick="toggleCode('M000122-source');return false;">[Source]</a></p>
1160           <div class="method-source-code" id="M000122-source">
1161 <pre>
1162 <span class="ruby-comment cmt"># File lib/git/base.rb, line 283</span>
1163     <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>)
1164       <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>)
1165     <span class="ruby-keyword kw">end</span>
1166 </pre>
1167           </div>
1168         </div>
1169       </div>
1170
1171       <div id="method-M000135" class="method-detail">
1172         <a name="M000135"></a>
1173
1174         <div class="method-heading">
1175           <a href="#M000135" class="method-signature">
1176           <span class="method-name">read_tree</span><span class="method-args">(treeish, opts = {})</span>
1177           </a>
1178         </div>
1179
1180         <div class="method-description">
1181           <p><a class="source-toggle" href="#"
1182             onclick="toggleCode('M000135-source');return false;">[Source]</a></p>
1183           <div class="method-source-code" id="M000135-source">
1184 <pre>
1185 <span class="ruby-comment cmt"># File lib/git/base.rb, line 368</span>
1186     <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> = {})
1187       <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>)
1188     <span class="ruby-keyword kw">end</span>
1189 </pre>
1190           </div>
1191         </div>
1192       </div>
1193
1194       <div id="method-M000110" class="method-detail">
1195         <a name="M000110"></a>
1196
1197         <div class="method-heading">
1198           <a href="#M000110" class="method-signature">
1199           <span class="method-name">remote</span><span class="method-args">(remote_name = 'origin')</span>
1200           </a>
1201         </div>
1202
1203         <div class="method-description">
1204           <p>
1205 returns a <a href="Remote.html">Git::Remote</a> object
1206 </p>
1207           <p><a class="source-toggle" href="#"
1208             onclick="toggleCode('M000110-source');return false;">[Source]</a></p>
1209           <div class="method-source-code" id="M000110-source">
1210 <pre>
1211 <span class="ruby-comment cmt"># File lib/git/base.rb, line 194</span>
1212     <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>)
1213       <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>)
1214     <span class="ruby-keyword kw">end</span>
1215 </pre>
1216           </div>
1217         </div>
1218       </div>
1219
1220       <div id="method-M000125" class="method-detail">
1221         <a name="M000125"></a>
1222
1223         <div class="method-heading">
1224           <a href="#M000125" class="method-signature">
1225           <span class="method-name">remotes</span><span class="method-args">()</span>
1226           </a>
1227         </div>
1228
1229         <div class="method-description">
1230           <p>
1231 returns an array of <a href="../Git.html">Git</a>:<a
1232 href="Remote.html">Remote</a> objects
1233 </p>
1234           <p><a class="source-toggle" href="#"
1235             onclick="toggleCode('M000125-source');return false;">[Source]</a></p>
1236           <div class="method-source-code" id="M000125-source">
1237 <pre>
1238 <span class="ruby-comment cmt"># File lib/git/base.rb, line 301</span>
1239     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">remotes</span>
1240       <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>) }
1241     <span class="ruby-keyword kw">end</span>
1242 </pre>
1243           </div>
1244         </div>
1245       </div>
1246
1247       <div id="method-M000115" class="method-detail">
1248         <a name="M000115"></a>
1249
1250         <div class="method-heading">
1251           <a href="#M000115" class="method-signature">
1252           <span class="method-name">remove</span><span class="method-args">(path = '.', opts = {})</span>
1253           </a>
1254         </div>
1255
1256         <div class="method-description">
1257           <p>
1258 removes file(s) from the git repository
1259 </p>
1260           <p><a class="source-toggle" href="#"
1261             onclick="toggleCode('M000115-source');return false;">[Source]</a></p>
1262           <div class="method-source-code" id="M000115-source">
1263 <pre>
1264 <span class="ruby-comment cmt"># File lib/git/base.rb, line 239</span>
1265     <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> = {})
1266       <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>)
1267     <span class="ruby-keyword kw">end</span>
1268 </pre>
1269           </div>
1270         </div>
1271       </div>
1272
1273       <div id="method-M000131" class="method-detail">
1274         <a name="M000131"></a>
1275
1276         <div class="method-heading">
1277           <a href="#M000131" class="method-signature">
1278           <span class="method-name">repack</span><span class="method-args">()</span>
1279           </a>
1280         </div>
1281
1282         <div class="method-description">
1283           <p>
1284 repacks the repository
1285 </p>
1286           <p><a class="source-toggle" href="#"
1287             onclick="toggleCode('M000131-source');return false;">[Source]</a></p>
1288           <div class="method-source-code" id="M000131-source">
1289 <pre>
1290 <span class="ruby-comment cmt"># File lib/git/base.rb, line 342</span>
1291     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">repack</span>
1292       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">repack</span>
1293     <span class="ruby-keyword kw">end</span>
1294 </pre>
1295           </div>
1296         </div>
1297       </div>
1298
1299       <div id="method-M000095" class="method-detail">
1300         <a name="M000095"></a>
1301
1302         <div class="method-heading">
1303           <a href="#M000095" class="method-signature">
1304           <span class="method-name">repo</span><span class="method-args">()</span>
1305           </a>
1306         </div>
1307
1308         <div class="method-description">
1309           <p>
1310 returns reference to the git repository directory
1311 </p>
1312 <pre>
1313  @git.dir.path
1314 </pre>
1315           <p><a class="source-toggle" href="#"
1316             onclick="toggleCode('M000095-source');return false;">[Source]</a></p>
1317           <div class="method-source-code" id="M000095-source">
1318 <pre>
1319 <span class="ruby-comment cmt"># File lib/git/base.rb, line 86</span>
1320     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">repo</span>
1321       <span class="ruby-ivar">@repository</span>
1322     <span class="ruby-keyword kw">end</span>
1323 </pre>
1324           </div>
1325         </div>
1326       </div>
1327
1328       <div id="method-M000100" class="method-detail">
1329         <a name="M000100"></a>
1330
1331         <div class="method-heading">
1332           <a href="#M000100" class="method-signature">
1333           <span class="method-name">repo_size</span><span class="method-args">()</span>
1334           </a>
1335         </div>
1336
1337         <div class="method-description">
1338           <p>
1339 returns the repository size in bytes
1340 </p>
1341           <p><a class="source-toggle" href="#"
1342             onclick="toggleCode('M000100-source');return false;">[Source]</a></p>
1343           <div class="method-source-code" id="M000100-source">
1344 <pre>
1345 <span class="ruby-comment cmt"># File lib/git/base.rb, line 122</span>
1346     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">repo_size</span>
1347       <span class="ruby-identifier">size</span> = <span class="ruby-value">0</span>
1348       <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>
1349         (<span class="ruby-identifier">size</span>, <span class="ruby-identifier">dot</span>) = <span class="ruby-value">`du -d0`</span>.<span class="ruby-identifier">chomp</span>.<span class="ruby-identifier">split</span>
1350       <span class="ruby-keyword kw">end</span>
1351       <span class="ruby-identifier">size</span>.<span class="ruby-identifier">to_i</span>
1352     <span class="ruby-keyword kw">end</span>
1353 </pre>
1354           </div>
1355         </div>
1356       </div>
1357
1358       <div id="method-M000116" class="method-detail">
1359         <a name="M000116"></a>
1360
1361         <div class="method-heading">
1362           <a href="#M000116" class="method-signature">
1363           <span class="method-name">reset</span><span class="method-args">(commitish = nil, opts = {})</span>
1364           </a>
1365         </div>
1366
1367         <div class="method-description">
1368           <p>
1369 resets the working directory to the provided commitish
1370 </p>
1371           <p><a class="source-toggle" href="#"
1372             onclick="toggleCode('M000116-source');return false;">[Source]</a></p>
1373           <div class="method-source-code" id="M000116-source">
1374 <pre>
1375 <span class="ruby-comment cmt"># File lib/git/base.rb, line 244</span>
1376     <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> = {})
1377       <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>)
1378     <span class="ruby-keyword kw">end</span>
1379 </pre>
1380           </div>
1381         </div>
1382       </div>
1383
1384       <div id="method-M000117" class="method-detail">
1385         <a name="M000117"></a>
1386
1387         <div class="method-heading">
1388           <a href="#M000117" class="method-signature">
1389           <span class="method-name">reset_hard</span><span class="method-args">(commitish = nil, opts = {})</span>
1390           </a>
1391         </div>
1392
1393         <div class="method-description">
1394           <p>
1395 resets the working directory to the commitish with
1396 &#8217;&#8212;hard&#8217;
1397 </p>
1398           <p><a class="source-toggle" href="#"
1399             onclick="toggleCode('M000117-source');return false;">[Source]</a></p>
1400           <div class="method-source-code" id="M000117-source">
1401 <pre>
1402 <span class="ruby-comment cmt"># File lib/git/base.rb, line 249</span>
1403     <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> = {})
1404       <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>)
1405       <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>)
1406     <span class="ruby-keyword kw">end</span>
1407 </pre>
1408           </div>
1409         </div>
1410       </div>
1411
1412       <div id="method-M000143" class="method-detail">
1413         <a name="M000143"></a>
1414
1415         <div class="method-heading">
1416           <a href="#M000143" class="method-signature">
1417           <span class="method-name">revparse</span><span class="method-args">(objectish)</span>
1418           </a>
1419         </div>
1420
1421         <div class="method-description">
1422           <p>
1423 runs git rev-parse to convert the objectish to a full sha
1424 </p>
1425 <pre>
1426   @git.revparse(&quot;HEAD^^&quot;)
1427   @git.revparse('v2.4^{tree}')
1428   @git.revparse('v2.4:/doc/index.html')
1429 </pre>
1430           <p><a class="source-toggle" href="#"
1431             onclick="toggleCode('M000143-source');return false;">[Source]</a></p>
1432           <div class="method-source-code" id="M000143-source">
1433 <pre>
1434 <span class="ruby-comment cmt"># File lib/git/base.rb, line 420</span>
1435     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">revparse</span>(<span class="ruby-identifier">objectish</span>)
1436       <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>)
1437     <span class="ruby-keyword kw">end</span>
1438 </pre>
1439           </div>
1440         </div>
1441       </div>
1442
1443       <div id="method-M000098" class="method-detail">
1444         <a name="M000098"></a>
1445
1446         <div class="method-heading">
1447           <a href="#M000098" class="method-signature">
1448           <span class="method-name">set_index</span><span class="method-args">(index_file, check = true)</span>
1449           </a>
1450         </div>
1451
1452         <div class="method-description">
1453           <p><a class="source-toggle" href="#"
1454             onclick="toggleCode('M000098-source');return false;">[Source]</a></p>
1455           <div class="method-source-code" id="M000098-source">
1456 <pre>
1457 <span class="ruby-comment cmt"># File lib/git/base.rb, line 101</span>
1458     <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>)
1459       <span class="ruby-ivar">@lib</span> = <span class="ruby-keyword kw">nil</span>
1460       <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>)
1461     <span class="ruby-keyword kw">end</span>
1462 </pre>
1463           </div>
1464         </div>
1465       </div>
1466
1467       <div id="method-M000097" class="method-detail">
1468         <a name="M000097"></a>
1469
1470         <div class="method-heading">
1471           <a href="#M000097" class="method-signature">
1472           <span class="method-name">set_working</span><span class="method-args">(work_dir, check = true)</span>
1473           </a>
1474         </div>
1475
1476         <div class="method-description">
1477           <p><a class="source-toggle" href="#"
1478             onclick="toggleCode('M000097-source');return false;">[Source]</a></p>
1479           <div class="method-source-code" id="M000097-source">
1480 <pre>
1481 <span class="ruby-comment cmt"># File lib/git/base.rb, line 96</span>
1482     <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>)
1483       <span class="ruby-ivar">@lib</span> = <span class="ruby-keyword kw">nil</span>
1484       <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>)
1485     <span class="ruby-keyword kw">end</span>
1486 </pre>
1487           </div>
1488         </div>
1489       </div>
1490
1491       <div id="method-M000107" class="method-detail">
1492         <a name="M000107"></a>
1493
1494         <div class="method-heading">
1495           <a href="#M000107" class="method-signature">
1496           <span class="method-name">status</span><span class="method-args">()</span>
1497           </a>
1498         </div>
1499
1500         <div class="method-description">
1501           <p>
1502 returns a <a href="Status.html">Git::Status</a> object
1503 </p>
1504           <p><a class="source-toggle" href="#"
1505             onclick="toggleCode('M000107-source');return false;">[Source]</a></p>
1506           <div class="method-source-code" id="M000107-source">
1507 <pre>
1508 <span class="ruby-comment cmt"># File lib/git/base.rb, line 179</span>
1509     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">status</span>
1510       <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>)
1511     <span class="ruby-keyword kw">end</span>
1512 </pre>
1513           </div>
1514         </div>
1515       </div>
1516
1517       <div id="method-M000128" class="method-detail">
1518         <a name="M000128"></a>
1519
1520         <div class="method-heading">
1521           <a href="#M000128" class="method-signature">
1522           <span class="method-name">tag</span><span class="method-args">(tag_name)</span>
1523           </a>
1524         </div>
1525
1526         <div class="method-description">
1527           <p>
1528 returns a Git::Tag object
1529 </p>
1530           <p><a class="source-toggle" href="#"
1531             onclick="toggleCode('M000128-source');return false;">[Source]</a></p>
1532           <div class="method-source-code" id="M000128-source">
1533 <pre>
1534 <span class="ruby-comment cmt"># File lib/git/base.rb, line 326</span>
1535     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">tag</span>(<span class="ruby-identifier">tag_name</span>)
1536       <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>)
1537     <span class="ruby-keyword kw">end</span>
1538 </pre>
1539           </div>
1540         </div>
1541       </div>
1542
1543       <div id="method-M000127" class="method-detail">
1544         <a name="M000127"></a>
1545
1546         <div class="method-heading">
1547           <a href="#M000127" class="method-signature">
1548           <span class="method-name">tags</span><span class="method-args">()</span>
1549           </a>
1550         </div>
1551
1552         <div class="method-description">
1553           <p>
1554 returns an array of all Git::Tag objects for this repository
1555 </p>
1556           <p><a class="source-toggle" href="#"
1557             onclick="toggleCode('M000127-source');return false;">[Source]</a></p>
1558           <div class="method-source-code" id="M000127-source">
1559 <pre>
1560 <span class="ruby-comment cmt"># File lib/git/base.rb, line 321</span>
1561     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">tags</span>
1562       <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>) }
1563     <span class="ruby-keyword kw">end</span>
1564 </pre>
1565           </div>
1566         </div>
1567       </div>
1568
1569       <div id="method-M000139" class="method-detail">
1570         <a name="M000139"></a>
1571
1572         <div class="method-heading">
1573           <a href="#M000139" class="method-signature">
1574           <span class="method-name">update_ref</span><span class="method-args">(branch, commit)</span>
1575           </a>
1576         </div>
1577
1578         <div class="method-description">
1579           <p><a class="source-toggle" href="#"
1580             onclick="toggleCode('M000139-source');return false;">[Source]</a></p>
1581           <div class="method-source-code" id="M000139-source">
1582 <pre>
1583 <span class="ruby-comment cmt"># File lib/git/base.rb, line 385</span>
1584     <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>)
1585       <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>)
1586     <span class="ruby-keyword kw">end</span>
1587 </pre>
1588           </div>
1589         </div>
1590       </div>
1591
1592       <div id="method-M000132" class="method-detail">
1593         <a name="M000132"></a>
1594
1595         <div class="method-heading">
1596           <a href="#M000132" class="method-signature">
1597           <span class="method-name">with_index</span><span class="method-args">(new_index) {|@index| ...}</span>
1598           </a>
1599         </div>
1600
1601         <div class="method-description">
1602           <p>
1603 LOWER LEVEL INDEX OPERATIONS ##
1604 </p>
1605           <p><a class="source-toggle" href="#"
1606             onclick="toggleCode('M000132-source');return false;">[Source]</a></p>
1607           <div class="method-source-code" id="M000132-source">
1608 <pre>
1609 <span class="ruby-comment cmt"># File lib/git/base.rb, line 349</span>
1610     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">with_index</span>(<span class="ruby-identifier">new_index</span>)
1611       <span class="ruby-identifier">old_index</span> = <span class="ruby-ivar">@index</span>
1612       <span class="ruby-identifier">set_index</span>(<span class="ruby-identifier">new_index</span>, <span class="ruby-keyword kw">false</span>)
1613       <span class="ruby-identifier">return_value</span> = <span class="ruby-keyword kw">yield</span> <span class="ruby-ivar">@index</span>
1614       <span class="ruby-identifier">set_index</span>(<span class="ruby-identifier">old_index</span>)
1615       <span class="ruby-identifier">return_value</span>
1616     <span class="ruby-keyword kw">end</span>
1617 </pre>
1618           </div>
1619         </div>
1620       </div>
1621
1622       <div id="method-M000133" class="method-detail">
1623         <a name="M000133"></a>
1624
1625         <div class="method-heading">
1626           <a href="#M000133" class="method-signature">
1627           <span class="method-name">with_temp_index</span><span class="method-args">(&amp;blk)</span>
1628           </a>
1629         </div>
1630
1631         <div class="method-description">
1632           <p><a class="source-toggle" href="#"
1633             onclick="toggleCode('M000133-source');return false;">[Source]</a></p>
1634           <div class="method-source-code" id="M000133-source">
1635 <pre>
1636 <span class="ruby-comment cmt"># File lib/git/base.rb, line 357</span>
1637     <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>
1638       <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>)
1639       <span class="ruby-identifier">temp_path</span> = <span class="ruby-identifier">tempfile</span>.<span class="ruby-identifier">path</span>
1640       <span class="ruby-identifier">tempfile</span>.<span class="ruby-identifier">unlink</span>
1641       <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>)
1642     <span class="ruby-keyword kw">end</span>
1643 </pre>
1644           </div>
1645         </div>
1646       </div>
1647
1648       <div id="method-M000142" class="method-detail">
1649         <a name="M000142"></a>
1650
1651         <div class="method-heading">
1652           <a href="#M000142" class="method-signature">
1653           <span class="method-name">with_temp_working</span><span class="method-args">(&amp;blk)</span>
1654           </a>
1655         </div>
1656
1657         <div class="method-description">
1658           <p><a class="source-toggle" href="#"
1659             onclick="toggleCode('M000142-source');return false;">[Source]</a></p>
1660           <div class="method-source-code" id="M000142-source">
1661 <pre>
1662 <span class="ruby-comment cmt"># File lib/git/base.rb, line 405</span>
1663     <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>
1664       <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>)
1665       <span class="ruby-identifier">temp_dir</span> = <span class="ruby-identifier">tempfile</span>.<span class="ruby-identifier">path</span>
1666       <span class="ruby-identifier">tempfile</span>.<span class="ruby-identifier">unlink</span>
1667       <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>)
1668       <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>)
1669     <span class="ruby-keyword kw">end</span>
1670 </pre>
1671           </div>
1672         </div>
1673       </div>
1674
1675       <div id="method-M000141" class="method-detail">
1676         <a name="M000141"></a>
1677
1678         <div class="method-heading">
1679           <a href="#M000141" class="method-signature">
1680           <span class="method-name">with_working</span><span class="method-args">(work_dir) {|@working_directory| ...}</span>
1681           </a>
1682         </div>
1683
1684         <div class="method-description">
1685           <p><a class="source-toggle" href="#"
1686             onclick="toggleCode('M000141-source');return false;">[Source]</a></p>
1687           <div class="method-source-code" id="M000141-source">
1688 <pre>
1689 <span class="ruby-comment cmt"># File lib/git/base.rb, line 394</span>
1690     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">with_working</span>(<span class="ruby-identifier">work_dir</span>)
1691       <span class="ruby-identifier">return_value</span> = <span class="ruby-keyword kw">false</span>
1692       <span class="ruby-identifier">old_working</span> = <span class="ruby-ivar">@working_directory</span>
1693       <span class="ruby-identifier">set_working</span>(<span class="ruby-identifier">work_dir</span>)
1694       <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>
1695         <span class="ruby-identifier">return_value</span> = <span class="ruby-keyword kw">yield</span> <span class="ruby-ivar">@working_directory</span>
1696       <span class="ruby-keyword kw">end</span>
1697       <span class="ruby-identifier">set_working</span>(<span class="ruby-identifier">old_working</span>)
1698       <span class="ruby-identifier">return_value</span>
1699     <span class="ruby-keyword kw">end</span>
1700 </pre>
1701           </div>
1702         </div>
1703       </div>
1704
1705       <div id="method-M000138" class="method-detail">
1706         <a name="M000138"></a>
1707
1708         <div class="method-heading">
1709           <a href="#M000138" class="method-signature">
1710           <span class="method-name">write_and_commit_tree</span><span class="method-args">(opts = {})</span>
1711           </a>
1712         </div>
1713
1714         <div class="method-description">
1715           <p><a class="source-toggle" href="#"
1716             onclick="toggleCode('M000138-source');return false;">[Source]</a></p>
1717           <div class="method-source-code" id="M000138-source">
1718 <pre>
1719 <span class="ruby-comment cmt"># File lib/git/base.rb, line 380</span>
1720     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">write_and_commit_tree</span>(<span class="ruby-identifier">opts</span> = {})
1721       <span class="ruby-identifier">tree</span> = <span class="ruby-identifier">write_tree</span>
1722       <span class="ruby-identifier">commit_tree</span>(<span class="ruby-identifier">tree</span>, <span class="ruby-identifier">opts</span>)
1723     <span class="ruby-keyword kw">end</span>
1724 </pre>
1725           </div>
1726         </div>
1727       </div>
1728
1729       <div id="method-M000136" class="method-detail">
1730         <a name="M000136"></a>
1731
1732         <div class="method-heading">
1733           <a href="#M000136" class="method-signature">
1734           <span class="method-name">write_tree</span><span class="method-args">()</span>
1735           </a>
1736         </div>
1737
1738         <div class="method-description">
1739           <p><a class="source-toggle" href="#"
1740             onclick="toggleCode('M000136-source');return false;">[Source]</a></p>
1741           <div class="method-source-code" id="M000136-source">
1742 <pre>
1743 <span class="ruby-comment cmt"># File lib/git/base.rb, line 372</span>
1744     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">write_tree</span>
1745       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">write_tree</span>
1746     <span class="ruby-keyword kw">end</span>
1747 </pre>
1748           </div>
1749         </div>
1750       </div>
1751
1752
1753     </div>
1754
1755
1756   </div>
1757
1758
1759 <div id="validator-badges">
1760   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
1761 </div>
1762
1763 </body>
1764 </html>