doc/classes/Git.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>Module: Git</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>Module</strong></td>
  53           <td class="class-name-in-header">Git</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                 <a href="../files/lib/git/branch_rb.html">
  63                 lib/git/branch.rb
  64                 </a>
  65         <br />
  66                 <a href="../files/lib/git/branches_rb.html">
  67                 lib/git/branches.rb
  68                 </a>
  69         <br />
  70                 <a href="../files/lib/git/diff_rb.html">
  71                 lib/git/diff.rb
  72                 </a>
  73         <br />
  74                 <a href="../files/lib/git/index_rb.html">
  75                 lib/git/index.rb
  76                 </a>
  77         <br />
  78                 <a href="../files/lib/git/lib_rb.html">
  79                 lib/git/lib.rb
  80                 </a>
  81         <br />
  82                 <a href="../files/lib/git/log_rb.html">
  83                 lib/git/log.rb
  84                 </a>
  85         <br />
  86                 <a href="../files/lib/git/object_rb.html">
  87                 lib/git/object.rb
  88                 </a>
  89         <br />
  90                 <a href="../files/lib/git/path_rb.html">
  91                 lib/git/path.rb
  92                 </a>
  93         <br />
  94                 <a href="../files/lib/git/remote_rb.html">
  95                 lib/git/remote.rb
  96                 </a>
  97         <br />
  98                 <a href="../files/lib/git/repository_rb.html">
  99                 lib/git/repository.rb
 100                 </a>
 101         <br />
 102                 <a href="../files/lib/git/status_rb.html">
 103                 lib/git/status.rb
 104                 </a>
 105         <br />
 106                 <a href="../files/lib/git/working_directory_rb.html">
 107                 lib/git/working_directory.rb
 108                 </a>
 109         <br />
 110                 <a href="../files/lib/git_rb.html">
 111                 lib/git.rb
 112                 </a>
 113         <br />
 114             </td>
 115         </tr>
 116
 117         </table>
 118     </div>
 119   <!-- banner header -->
 120
 121   <div id="bodyContent">
 122
 123
 124
 125   <div id="contextContent">
 126
 127
 128
 129    </div>
 130
 131     <div id="method-list">
 132       <h3 class="section-bar">Methods</h3>
 133
 134       <div class="name-list">
 135       <a href="#M000001">bare</a>&nbsp;&nbsp;
 136       <a href="#M000004">clone</a>&nbsp;&nbsp;
 137       <a href="#M000003">init</a>&nbsp;&nbsp;
 138       <a href="#M000002">open</a>&nbsp;&nbsp;
 139       </div>
 140     </div>
 141
 142   </div>
 143
 144
 145     <!-- if includes -->
 146
 147     <div id="section">
 148
 149     <div id="class-list">
 150       <h3 class="section-bar">Classes and Modules</h3>
 151
 152       Class <a href="Git/Base.html" class="link">Git::Base</a><br />
 153 Class <a href="Git/Branch.html" class="link">Git::Branch</a><br />
 154 Class <a href="Git/Branches.html" class="link">Git::Branches</a><br />
 155 Class <a href="Git/Diff.html" class="link">Git::Diff</a><br />
 156 Class <a href="Git/GitExecuteError.html" class="link">Git::GitExecuteError</a><br />
 157 Class <a href="Git/GitTagNameDoesNotExist.html" class="link">Git::GitTagNameDoesNotExist</a><br />
 158 Class <a href="Git/Index.html" class="link">Git::Index</a><br />
 159 Class <a href="Git/Lib.html" class="link">Git::Lib</a><br />
 160 Class <a href="Git/Log.html" class="link">Git::Log</a><br />
 161 Class <a href="Git/Object.html" class="link">Git::Object</a><br />
 162 Class <a href="Git/Path.html" class="link">Git::Path</a><br />
 163 Class <a href="Git/Remote.html" class="link">Git::Remote</a><br />
 164 Class <a href="Git/Repository.html" class="link">Git::Repository</a><br />
 165 Class <a href="Git/Status.html" class="link">Git::Status</a><br />
 166 Class <a href="Git/WorkingDirectory.html" class="link">Git::WorkingDirectory</a><br />
 167
 168     </div>
 169
 170
 171
 172
 173
 174
 175
 176     <!-- if method_list -->
 177     <div id="methods">
 178       <h3 class="section-bar">Public Class methods</h3>
 179
 180       <div id="method-M000001" class="method-detail">
 181         <a name="M000001"></a>
 182
 183         <div class="method-heading">
 184           <a href="#M000001" class="method-signature">
 185           <span class="method-name">bare</span><span class="method-args">(git_dir)</span>
 186           </a>
 187         </div>
 188
 189         <div class="method-description">
 190           <p><a class="source-toggle" href="#"
 191             onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
 192           <div class="method-source-code" id="M000001-source">
 193 <pre>
 194 <span class="ruby-comment cmt"># File lib/git.rb, line 34</span>
 195   <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>)
 196     <span class="ruby-constant">Base</span>.<span class="ruby-identifier">bare</span>(<span class="ruby-identifier">git_dir</span>)
 197   <span class="ruby-keyword kw">end</span>
 198 </pre>
 199           </div>
 200         </div>
 201       </div>
 202
 203       <div id="method-M000004" class="method-detail">
 204         <a name="M000004"></a>
 205
 206         <div class="method-heading">
 207           <a href="#M000004" class="method-signature">
 208           <span class="method-name">clone</span><span class="method-args">(repository, name, options = {})</span>
 209           </a>
 210         </div>
 211
 212         <div class="method-description">
 213           <p><a class="source-toggle" href="#"
 214             onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
 215           <div class="method-source-code" id="M000004-source">
 216 <pre>
 217 <span class="ruby-comment cmt"># File lib/git.rb, line 46</span>
 218   <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">options</span> = {})
 219     <span class="ruby-constant">Base</span>.<span class="ruby-identifier">clone</span>(<span class="ruby-identifier">repository</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span>)
 220   <span class="ruby-keyword kw">end</span>
 221 </pre>
 222           </div>
 223         </div>
 224       </div>
 225
 226       <div id="method-M000003" class="method-detail">
 227         <a name="M000003"></a>
 228
 229         <div class="method-heading">
 230           <a href="#M000003" class="method-signature">
 231           <span class="method-name">init</span><span class="method-args">(working_dir = '.', options = {})</span>
 232           </a>
 233         </div>
 234
 235         <div class="method-description">
 236           <p><a class="source-toggle" href="#"
 237             onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
 238           <div class="method-source-code" id="M000003-source">
 239 <pre>
 240 <span class="ruby-comment cmt"># File lib/git.rb, line 42</span>
 241   <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-value str">'.'</span>, <span class="ruby-identifier">options</span> = {})
 242     <span class="ruby-constant">Base</span>.<span class="ruby-identifier">init</span>(<span class="ruby-identifier">working_dir</span>, <span class="ruby-identifier">options</span>)
 243   <span class="ruby-keyword kw">end</span>
 244 </pre>
 245           </div>
 246         </div>
 247       </div>
 248
 249       <div id="method-M000002" class="method-detail">
 250         <a name="M000002"></a>
 251
 252         <div class="method-heading">
 253           <a href="#M000002" class="method-signature">
 254           <span class="method-name">open</span><span class="method-args">(working_dir, options = {})</span>
 255           </a>
 256         </div>
 257
 258         <div class="method-description">
 259           <p><a class="source-toggle" href="#"
 260             onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
 261           <div class="method-source-code" id="M000002-source">
 262 <pre>
 263 <span class="ruby-comment cmt"># File lib/git.rb, line 38</span>
 264   <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">options</span> = {})
 265     <span class="ruby-constant">Base</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">working_dir</span>, <span class="ruby-identifier">options</span>)
 266   <span class="ruby-keyword kw">end</span>
 267 </pre>
 268           </div>
 269         </div>
 270       </div>
 271
 272
 273     </div>
 274
 275
 276   </div>
 277
 278
 279 <div id="validator-badges">
 280   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 281 </div>
 282
 283 </body>
 284 </html>