doc/classes/Git/Object/Commit.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::Object::Commit</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::Object::Commit</td>
  54         </tr>
  55         <tr class="top-aligned-row">
  56             <td><strong>In:</strong></td>
  57             <td>
  58                 <a href="../../../files/lib/git/object_rb.html">
  59                 lib/git/object.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="AbstractObject.html">
  69                 AbstractObject
  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="#M000158">author</a>&nbsp;&nbsp;
  92       <a href="#M000159">author_date</a>&nbsp;&nbsp;
  93       <a href="#M000160">committer</a>&nbsp;&nbsp;
  94       <a href="#M000161">committer_date</a>&nbsp;&nbsp;
  95       <a href="#M000162">date</a>&nbsp;&nbsp;
  96       <a href="#M000163">diff_parent</a>&nbsp;&nbsp;
  97       <a href="#M000155">gtree</a>&nbsp;&nbsp;
  98       <a href="#M000153">message</a>&nbsp;&nbsp;
  99       <a href="#M000154">name</a>&nbsp;&nbsp;
 100       <a href="#M000152">new</a>&nbsp;&nbsp;
 101       <a href="#M000156">parent</a>&nbsp;&nbsp;
 102       <a href="#M000157">parents</a>&nbsp;&nbsp;
 103       <a href="#M000164">set_commit</a>&nbsp;&nbsp;
 104       </div>
 105     </div>
 106
 107   </div>
 108
 109
 110     <!-- if includes -->
 111
 112     <div id="section">
 113
 114
 115
 116
 117
 118
 119
 120
 121     <!-- if method_list -->
 122     <div id="methods">
 123       <h3 class="section-bar">Public Class methods</h3>
 124
 125       <div id="method-M000152" class="method-detail">
 126         <a name="M000152"></a>
 127
 128         <div class="method-heading">
 129           <a href="#M000152" class="method-signature">
 130           <span class="method-name">new</span><span class="method-args">(base, sha, init = nil)</span>
 131           </a>
 132         </div>
 133
 134         <div class="method-description">
 135           <p><a class="source-toggle" href="#"
 136             onclick="toggleCode('M000152-source');return false;">[Source]</a></p>
 137           <div class="method-source-code" id="M000152-source">
 138 <pre>
 139 <span class="ruby-comment cmt"># File lib/git/object.rb, line 154</span>
 140       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">base</span>, <span class="ruby-identifier">sha</span>, <span class="ruby-identifier">init</span> = <span class="ruby-keyword kw">nil</span>)
 141         <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">base</span>, <span class="ruby-identifier">sha</span>)
 142         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">init</span>
 143           <span class="ruby-identifier">set_commit</span>(<span class="ruby-identifier">init</span>)
 144         <span class="ruby-keyword kw">end</span>
 145       <span class="ruby-keyword kw">end</span>
 146 </pre>
 147           </div>
 148         </div>
 149       </div>
 150
 151       <h3 class="section-bar">Public Instance methods</h3>
 152
 153       <div id="method-M000158" class="method-detail">
 154         <a name="M000158"></a>
 155
 156         <div class="method-heading">
 157           <a href="#M000158" class="method-signature">
 158           <span class="method-name">author</span><span class="method-args">()</span>
 159           </a>
 160         </div>
 161
 162         <div class="method-description">
 163           <p>
 164 git author
 165 </p>
 166           <p><a class="source-toggle" href="#"
 167             onclick="toggleCode('M000158-source');return false;">[Source]</a></p>
 168           <div class="method-source-code" id="M000158-source">
 169 <pre>
 170 <span class="ruby-comment cmt"># File lib/git/object.rb, line 186</span>
 171       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">author</span>
 172         <span class="ruby-identifier">check_commit</span>
 173         <span class="ruby-ivar">@author</span>
 174       <span class="ruby-keyword kw">end</span>
 175 </pre>
 176           </div>
 177         </div>
 178       </div>
 179
 180       <div id="method-M000159" class="method-detail">
 181         <a name="M000159"></a>
 182
 183         <div class="method-heading">
 184           <a href="#M000159" class="method-signature">
 185           <span class="method-name">author_date</span><span class="method-args">()</span>
 186           </a>
 187         </div>
 188
 189         <div class="method-description">
 190           <p><a class="source-toggle" href="#"
 191             onclick="toggleCode('M000159-source');return false;">[Source]</a></p>
 192           <div class="method-source-code" id="M000159-source">
 193 <pre>
 194 <span class="ruby-comment cmt"># File lib/git/object.rb, line 191</span>
 195       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">author_date</span>
 196         <span class="ruby-identifier">author</span>.<span class="ruby-identifier">date</span>
 197       <span class="ruby-keyword kw">end</span>
 198 </pre>
 199           </div>
 200         </div>
 201       </div>
 202
 203       <div id="method-M000160" class="method-detail">
 204         <a name="M000160"></a>
 205
 206         <div class="method-heading">
 207           <a href="#M000160" class="method-signature">
 208           <span class="method-name">committer</span><span class="method-args">()</span>
 209           </a>
 210         </div>
 211
 212         <div class="method-description">
 213           <p>
 214 git author
 215 </p>
 216           <p><a class="source-toggle" href="#"
 217             onclick="toggleCode('M000160-source');return false;">[Source]</a></p>
 218           <div class="method-source-code" id="M000160-source">
 219 <pre>
 220 <span class="ruby-comment cmt"># File lib/git/object.rb, line 196</span>
 221       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">committer</span>
 222         <span class="ruby-identifier">check_commit</span>
 223         <span class="ruby-ivar">@committer</span>
 224       <span class="ruby-keyword kw">end</span>
 225 </pre>
 226           </div>
 227         </div>
 228       </div>
 229
 230       <div id="method-M000161" class="method-detail">
 231         <a name="M000161"></a>
 232
 233         <div class="method-heading">
 234           <a href="#M000161" class="method-signature">
 235           <span class="method-name">committer_date</span><span class="method-args">()</span>
 236           </a>
 237         </div>
 238
 239         <div class="method-description">
 240           <p><a class="source-toggle" href="#"
 241             onclick="toggleCode('M000161-source');return false;">[Source]</a></p>
 242           <div class="method-source-code" id="M000161-source">
 243 <pre>
 244 <span class="ruby-comment cmt"># File lib/git/object.rb, line 201</span>
 245       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">committer_date</span>
 246         <span class="ruby-identifier">committer</span>.<span class="ruby-identifier">date</span>
 247       <span class="ruby-keyword kw">end</span>
 248 </pre>
 249           </div>
 250         </div>
 251       </div>
 252
 253       <div id="method-M000162" class="method-detail">
 254         <a name="M000162"></a>
 255
 256         <div class="method-heading">
 257           <span class="method-name">date</span><span class="method-args">()</span>
 258         </div>
 259
 260         <div class="method-description">
 261           <p>
 262 Alias for <a href="Commit.html#M000161">committer_date</a>
 263 </p>
 264         </div>
 265       </div>
 266
 267       <div id="method-M000163" class="method-detail">
 268         <a name="M000163"></a>
 269
 270         <div class="method-heading">
 271           <a href="#M000163" class="method-signature">
 272           <span class="method-name">diff_parent</span><span class="method-args">()</span>
 273           </a>
 274         </div>
 275
 276         <div class="method-description">
 277           <p><a class="source-toggle" href="#"
 278             onclick="toggleCode('M000163-source');return false;">[Source]</a></p>
 279           <div class="method-source-code" id="M000163-source">
 280 <pre>
 281 <span class="ruby-comment cmt"># File lib/git/object.rb, line 206</span>
 282       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">diff_parent</span>
 283         <span class="ruby-identifier">diff</span>(<span class="ruby-identifier">parent</span>)
 284       <span class="ruby-keyword kw">end</span>
 285 </pre>
 286           </div>
 287         </div>
 288       </div>
 289
 290       <div id="method-M000155" class="method-detail">
 291         <a name="M000155"></a>
 292
 293         <div class="method-heading">
 294           <a href="#M000155" class="method-signature">
 295           <span class="method-name">gtree</span><span class="method-args">()</span>
 296           </a>
 297         </div>
 298
 299         <div class="method-description">
 300           <p><a class="source-toggle" href="#"
 301             onclick="toggleCode('M000155-source');return false;">[Source]</a></p>
 302           <div class="method-source-code" id="M000155-source">
 303 <pre>
 304 <span class="ruby-comment cmt"># File lib/git/object.rb, line 170</span>
 305       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">gtree</span>
 306         <span class="ruby-identifier">check_commit</span>
 307         <span class="ruby-constant">Tree</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@base</span>, <span class="ruby-ivar">@tree</span>)
 308       <span class="ruby-keyword kw">end</span>
 309 </pre>
 310           </div>
 311         </div>
 312       </div>
 313
 314       <div id="method-M000153" class="method-detail">
 315         <a name="M000153"></a>
 316
 317         <div class="method-heading">
 318           <a href="#M000153" class="method-signature">
 319           <span class="method-name">message</span><span class="method-args">()</span>
 320           </a>
 321         </div>
 322
 323         <div class="method-description">
 324           <p><a class="source-toggle" href="#"
 325             onclick="toggleCode('M000153-source');return false;">[Source]</a></p>
 326           <div class="method-source-code" id="M000153-source">
 327 <pre>
 328 <span class="ruby-comment cmt"># File lib/git/object.rb, line 161</span>
 329       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">message</span>
 330         <span class="ruby-identifier">check_commit</span>
 331         <span class="ruby-ivar">@message</span>
 332       <span class="ruby-keyword kw">end</span>
 333 </pre>
 334           </div>
 335         </div>
 336       </div>
 337
 338       <div id="method-M000154" class="method-detail">
 339         <a name="M000154"></a>
 340
 341         <div class="method-heading">
 342           <a href="#M000154" class="method-signature">
 343           <span class="method-name">name</span><span class="method-args">()</span>
 344           </a>
 345         </div>
 346
 347         <div class="method-description">
 348           <p><a class="source-toggle" href="#"
 349             onclick="toggleCode('M000154-source');return false;">[Source]</a></p>
 350           <div class="method-source-code" id="M000154-source">
 351 <pre>
 352 <span class="ruby-comment cmt"># File lib/git/object.rb, line 166</span>
 353       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">name</span>
 354         <span class="ruby-ivar">@base</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">namerev</span>(<span class="ruby-identifier">sha</span>)
 355       <span class="ruby-keyword kw">end</span>
 356 </pre>
 357           </div>
 358         </div>
 359       </div>
 360
 361       <div id="method-M000156" class="method-detail">
 362         <a name="M000156"></a>
 363
 364         <div class="method-heading">
 365           <a href="#M000156" class="method-signature">
 366           <span class="method-name">parent</span><span class="method-args">()</span>
 367           </a>
 368         </div>
 369
 370         <div class="method-description">
 371           <p><a class="source-toggle" href="#"
 372             onclick="toggleCode('M000156-source');return false;">[Source]</a></p>
 373           <div class="method-source-code" id="M000156-source">
 374 <pre>
 375 <span class="ruby-comment cmt"># File lib/git/object.rb, line 175</span>
 376       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parent</span>
 377         <span class="ruby-identifier">parents</span>.<span class="ruby-identifier">first</span>
 378       <span class="ruby-keyword kw">end</span>
 379 </pre>
 380           </div>
 381         </div>
 382       </div>
 383
 384       <div id="method-M000157" class="method-detail">
 385         <a name="M000157"></a>
 386
 387         <div class="method-heading">
 388           <a href="#M000157" class="method-signature">
 389           <span class="method-name">parents</span><span class="method-args">()</span>
 390           </a>
 391         </div>
 392
 393         <div class="method-description">
 394           <p>
 395 array of all parent commits
 396 </p>
 397           <p><a class="source-toggle" href="#"
 398             onclick="toggleCode('M000157-source');return false;">[Source]</a></p>
 399           <div class="method-source-code" id="M000157-source">
 400 <pre>
 401 <span class="ruby-comment cmt"># File lib/git/object.rb, line 180</span>
 402       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parents</span>
 403         <span class="ruby-identifier">check_commit</span>
 404         <span class="ruby-ivar">@parents</span>
 405       <span class="ruby-keyword kw">end</span>
 406 </pre>
 407           </div>
 408         </div>
 409       </div>
 410
 411       <div id="method-M000164" class="method-detail">
 412         <a name="M000164"></a>
 413
 414         <div class="method-heading">
 415           <a href="#M000164" class="method-signature">
 416           <span class="method-name">set_commit</span><span class="method-args">(data)</span>
 417           </a>
 418         </div>
 419
 420         <div class="method-description">
 421           <p><a class="source-toggle" href="#"
 422             onclick="toggleCode('M000164-source');return false;">[Source]</a></p>
 423           <div class="method-source-code" id="M000164-source">
 424 <pre>
 425 <span class="ruby-comment cmt"># File lib/git/object.rb, line 210</span>
 426       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_commit</span>(<span class="ruby-identifier">data</span>)
 427         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">data</span>[<span class="ruby-value str">'sha'</span>]
 428           <span class="ruby-ivar">@sha</span> = <span class="ruby-identifier">data</span>[<span class="ruby-value str">'sha'</span>]
 429         <span class="ruby-keyword kw">end</span>
 430         <span class="ruby-ivar">@committer</span> = <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Author</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">data</span>[<span class="ruby-value str">'committer'</span>])
 431         <span class="ruby-ivar">@author</span> = <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Author</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">data</span>[<span class="ruby-value str">'author'</span>])
 432         <span class="ruby-ivar">@tree</span> = <span class="ruby-constant">Tree</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@base</span>, <span class="ruby-identifier">data</span>[<span class="ruby-value str">'tree'</span>])
 433         <span class="ruby-ivar">@parents</span> = <span class="ruby-identifier">data</span>[<span class="ruby-value str">'parent'</span>].<span class="ruby-identifier">map</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">sha</span><span class="ruby-operator">|</span> <span class="ruby-constant">Commit</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@base</span>, <span class="ruby-identifier">sha</span>) }
 434         <span class="ruby-ivar">@message</span> = <span class="ruby-identifier">data</span>[<span class="ruby-value str">'message'</span>].<span class="ruby-identifier">chomp</span>
 435       <span class="ruby-keyword kw">end</span>
 436 </pre>
 437           </div>
 438         </div>
 439       </div>
 440
 441
 442     </div>
 443
 444
 445   </div>
 446
 447
 448 <div id="validator-badges">
 449   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 450 </div>
 451
 452 </body>
 453 </html>