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