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