doc/classes/Git/Log.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::Log</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::Log</td>
  54         </tr>
  55         <tr class="top-aligned-row">
  56             <td><strong>In:</strong></td>
  57             <td>
  58                 <a href="../../files/lib/git/log_rb.html">
  59                 lib/git/log.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     <div id="description">
  84       <p>
  85 object that holds the last X commits on given branch
  86 </p>
  87
  88     </div>
  89
  90
  91    </div>
  92
  93     <div id="method-list">
  94       <h3 class="section-bar">Methods</h3>
  95
  96       <div class="name-list">
  97       <a href="#M000019">between</a>&nbsp;&nbsp;
  98       <a href="#M000022">each</a>&nbsp;&nbsp;
  99       <a href="#M000023">first</a>&nbsp;&nbsp;
 100       <a href="#M000015">new</a>&nbsp;&nbsp;
 101       <a href="#M000016">object</a>&nbsp;&nbsp;
 102       <a href="#M000017">path</a>&nbsp;&nbsp;
 103       <a href="#M000018">since</a>&nbsp;&nbsp;
 104       <a href="#M000021">size</a>&nbsp;&nbsp;
 105       <a href="#M000020">to_s</a>&nbsp;&nbsp;
 106       </div>
 107     </div>
 108
 109   </div>
 110
 111
 112     <!-- if includes -->
 113     <div id="includes">
 114       <h3 class="section-bar">Included Modules</h3>
 115
 116       <div id="includes-list">
 117         <span class="include-name">Enumerable</span>
 118       </div>
 119     </div>
 120
 121     <div id="section">
 122
 123
 124
 125
 126
 127
 128
 129
 130     <!-- if method_list -->
 131     <div id="methods">
 132       <h3 class="section-bar">Public Class methods</h3>
 133
 134       <div id="method-M000015" class="method-detail">
 135         <a name="M000015"></a>
 136
 137         <div class="method-heading">
 138           <a href="#M000015" class="method-signature">
 139           <span class="method-name">new</span><span class="method-args">(base, count = 30)</span>
 140           </a>
 141         </div>
 142
 143         <div class="method-description">
 144           <p><a class="source-toggle" href="#"
 145             onclick="toggleCode('M000015-source');return false;">[Source]</a></p>
 146           <div class="method-source-code" id="M000015-source">
 147 <pre>
 148 <span class="ruby-comment cmt"># File lib/git/log.rb, line 18</span>
 149     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">base</span>, <span class="ruby-identifier">count</span> = <span class="ruby-value">30</span>)
 150       <span class="ruby-identifier">dirty_log</span>
 151       <span class="ruby-ivar">@base</span> = <span class="ruby-identifier">base</span>
 152       <span class="ruby-ivar">@count</span> = <span class="ruby-identifier">count</span>
 153     <span class="ruby-keyword kw">end</span>
 154 </pre>
 155           </div>
 156         </div>
 157       </div>
 158
 159       <h3 class="section-bar">Public Instance methods</h3>
 160
 161       <div id="method-M000019" class="method-detail">
 162         <a name="M000019"></a>
 163
 164         <div class="method-heading">
 165           <a href="#M000019" class="method-signature">
 166           <span class="method-name">between</span><span class="method-args">(sha1, sha2 = nil)</span>
 167           </a>
 168         </div>
 169
 170         <div class="method-description">
 171           <p><a class="source-toggle" href="#"
 172             onclick="toggleCode('M000019-source');return false;">[Source]</a></p>
 173           <div class="method-source-code" id="M000019-source">
 174 <pre>
 175 <span class="ruby-comment cmt"># File lib/git/log.rb, line 42</span>
 176     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">between</span>(<span class="ruby-identifier">sha1</span>, <span class="ruby-identifier">sha2</span> = <span class="ruby-keyword kw">nil</span>)
 177       <span class="ruby-identifier">dirty_log</span>
 178       <span class="ruby-ivar">@between</span> = [<span class="ruby-ivar">@base</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">revparse</span>(<span class="ruby-identifier">sha1</span>), <span class="ruby-ivar">@base</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">revparse</span>(<span class="ruby-identifier">sha2</span>)]
 179       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span>
 180     <span class="ruby-keyword kw">end</span>
 181 </pre>
 182           </div>
 183         </div>
 184       </div>
 185
 186       <div id="method-M000022" class="method-detail">
 187         <a name="M000022"></a>
 188
 189         <div class="method-heading">
 190           <a href="#M000022" class="method-signature">
 191           <span class="method-name">each</span><span class="method-args">() {|c| ...}</span>
 192           </a>
 193         </div>
 194
 195         <div class="method-description">
 196           <p><a class="source-toggle" href="#"
 197             onclick="toggleCode('M000022-source');return false;">[Source]</a></p>
 198           <div class="method-source-code" id="M000022-source">
 199 <pre>
 200 <span class="ruby-comment cmt"># File lib/git/log.rb, line 60</span>
 201     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">each</span>
 202       <span class="ruby-identifier">check_log</span>
 203       <span class="ruby-ivar">@commits</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
 204         <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">c</span>
 205       <span class="ruby-keyword kw">end</span>
 206     <span class="ruby-keyword kw">end</span>
 207 </pre>
 208           </div>
 209         </div>
 210       </div>
 211
 212       <div id="method-M000023" class="method-detail">
 213         <a name="M000023"></a>
 214
 215         <div class="method-heading">
 216           <a href="#M000023" class="method-signature">
 217           <span class="method-name">first</span><span class="method-args">()</span>
 218           </a>
 219         </div>
 220
 221         <div class="method-description">
 222           <p><a class="source-toggle" href="#"
 223             onclick="toggleCode('M000023-source');return false;">[Source]</a></p>
 224           <div class="method-source-code" id="M000023-source">
 225 <pre>
 226 <span class="ruby-comment cmt"># File lib/git/log.rb, line 67</span>
 227     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">first</span>
 228       <span class="ruby-identifier">check_log</span>
 229       <span class="ruby-ivar">@commits</span>.<span class="ruby-identifier">first</span> <span class="ruby-keyword kw">rescue</span> <span class="ruby-keyword kw">nil</span>
 230     <span class="ruby-keyword kw">end</span>
 231 </pre>
 232           </div>
 233         </div>
 234       </div>
 235
 236       <div id="method-M000016" class="method-detail">
 237         <a name="M000016"></a>
 238
 239         <div class="method-heading">
 240           <a href="#M000016" class="method-signature">
 241           <span class="method-name">object</span><span class="method-args">(objectish)</span>
 242           </a>
 243         </div>
 244
 245         <div class="method-description">
 246           <p><a class="source-toggle" href="#"
 247             onclick="toggleCode('M000016-source');return false;">[Source]</a></p>
 248           <div class="method-source-code" id="M000016-source">
 249 <pre>
 250 <span class="ruby-comment cmt"># File lib/git/log.rb, line 24</span>
 251     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">object</span>(<span class="ruby-identifier">objectish</span>)
 252       <span class="ruby-identifier">dirty_log</span>
 253       <span class="ruby-ivar">@object</span> = <span class="ruby-identifier">objectish</span>
 254       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span>
 255     <span class="ruby-keyword kw">end</span>
 256 </pre>
 257           </div>
 258         </div>
 259       </div>
 260
 261       <div id="method-M000017" class="method-detail">
 262         <a name="M000017"></a>
 263
 264         <div class="method-heading">
 265           <a href="#M000017" class="method-signature">
 266           <span class="method-name">path</span><span class="method-args">(path)</span>
 267           </a>
 268         </div>
 269
 270         <div class="method-description">
 271           <p><a class="source-toggle" href="#"
 272             onclick="toggleCode('M000017-source');return false;">[Source]</a></p>
 273           <div class="method-source-code" id="M000017-source">
 274 <pre>
 275 <span class="ruby-comment cmt"># File lib/git/log.rb, line 30</span>
 276     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">path</span>(<span class="ruby-identifier">path</span>)
 277       <span class="ruby-identifier">dirty_log</span>
 278       <span class="ruby-ivar">@path</span> = <span class="ruby-identifier">path</span>
 279       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span>
 280     <span class="ruby-keyword kw">end</span>
 281 </pre>
 282           </div>
 283         </div>
 284       </div>
 285
 286       <div id="method-M000018" class="method-detail">
 287         <a name="M000018"></a>
 288
 289         <div class="method-heading">
 290           <a href="#M000018" class="method-signature">
 291           <span class="method-name">since</span><span class="method-args">(date)</span>
 292           </a>
 293         </div>
 294
 295         <div class="method-description">
 296           <p><a class="source-toggle" href="#"
 297             onclick="toggleCode('M000018-source');return false;">[Source]</a></p>
 298           <div class="method-source-code" id="M000018-source">
 299 <pre>
 300 <span class="ruby-comment cmt"># File lib/git/log.rb, line 36</span>
 301     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">since</span>(<span class="ruby-identifier">date</span>)
 302       <span class="ruby-identifier">dirty_log</span>
 303       <span class="ruby-ivar">@since</span> = <span class="ruby-identifier">date</span>
 304       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span>
 305     <span class="ruby-keyword kw">end</span>
 306 </pre>
 307           </div>
 308         </div>
 309       </div>
 310
 311       <div id="method-M000021" class="method-detail">
 312         <a name="M000021"></a>
 313
 314         <div class="method-heading">
 315           <a href="#M000021" class="method-signature">
 316           <span class="method-name">size</span><span class="method-args">()</span>
 317           </a>
 318         </div>
 319
 320         <div class="method-description">
 321           <p>
 322 forces git log to run
 323 </p>
 324           <p><a class="source-toggle" href="#"
 325             onclick="toggleCode('M000021-source');return false;">[Source]</a></p>
 326           <div class="method-source-code" id="M000021-source">
 327 <pre>
 328 <span class="ruby-comment cmt"># File lib/git/log.rb, line 55</span>
 329     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">size</span>
 330       <span class="ruby-identifier">check_log</span>
 331       <span class="ruby-ivar">@commits</span>.<span class="ruby-identifier">size</span> <span class="ruby-keyword kw">rescue</span> <span class="ruby-keyword kw">nil</span>
 332     <span class="ruby-keyword kw">end</span>
 333 </pre>
 334           </div>
 335         </div>
 336       </div>
 337
 338       <div id="method-M000020" class="method-detail">
 339         <a name="M000020"></a>
 340
 341         <div class="method-heading">
 342           <a href="#M000020" class="method-signature">
 343           <span class="method-name">to_s</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('M000020-source');return false;">[Source]</a></p>
 350           <div class="method-source-code" id="M000020-source">
 351 <pre>
 352 <span class="ruby-comment cmt"># File lib/git/log.rb, line 48</span>
 353     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
 354       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">sha</span> }.<span class="ruby-identifier">join</span>(<span class="ruby-value str">&quot;\n&quot;</span>)
 355     <span class="ruby-keyword kw">end</span>
 356 </pre>
 357           </div>
 358         </div>
 359       </div>
 360
 361
 362     </div>
 363
 364
 365   </div>
 366
 367
 368 <div id="validator-badges">
 369   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 370 </div>
 371
 372 </body>
 373 </html>