File: Git.html

package info (click to toggle)
libgit-ruby 1.0.7-2
  • links: PTS, VCS
  • area: main
  • in suites: lenny, squeeze
  • size: 3,652 kB
  • ctags: 771
  • sloc: ruby: 3,211; sh: 226; makefile: 19
file content (378 lines) | stat: -rw-r--r-- 12,426 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Module: Git</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>



    <div id="classHeader">
        <table class="header-table">
        <tr class="top-aligned-row">
          <td><strong>Module</strong></td>
          <td class="class-name-in-header">Git</td>
        </tr>
        <tr class="top-aligned-row">
            <td><strong>In:</strong></td>
            <td>
                <a href="../files/lib/git/author_rb.html">
                lib/git/author.rb
                </a>
        <br />
                <a href="../files/lib/git/base_rb.html">
                lib/git/base.rb
                </a>
        <br />
                <a href="../files/lib/git/branch_rb.html">
                lib/git/branch.rb
                </a>
        <br />
                <a href="../files/lib/git/branches_rb.html">
                lib/git/branches.rb
                </a>
        <br />
                <a href="../files/lib/git/diff_rb.html">
                lib/git/diff.rb
                </a>
        <br />
                <a href="../files/lib/git/index_rb.html">
                lib/git/index.rb
                </a>
        <br />
                <a href="../files/lib/git/lib_rb.html">
                lib/git/lib.rb
                </a>
        <br />
                <a href="../files/lib/git/log_rb.html">
                lib/git/log.rb
                </a>
        <br />
                <a href="../files/lib/git/object_rb.html">
                lib/git/object.rb
                </a>
        <br />
                <a href="../files/lib/git/path_rb.html">
                lib/git/path.rb
                </a>
        <br />
                <a href="../files/lib/git/remote_rb.html">
                lib/git/remote.rb
                </a>
        <br />
                <a href="../files/lib/git/repository_rb.html">
                lib/git/repository.rb
                </a>
        <br />
                <a href="../files/lib/git/status_rb.html">
                lib/git/status.rb
                </a>
        <br />
                <a href="../files/lib/git/working_directory_rb.html">
                lib/git/working_directory.rb
                </a>
        <br />
                <a href="../files/lib/git_rb.html">
                lib/git.rb
                </a>
        <br />
            </td>
        </tr>

        </table>
    </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">

    <div id="description">
      <p>
<a href="Git.html">Git</a>/Ruby Library
</p>
<p>
This provides bindings for working with git in complex interactions,
including branching and merging, object inspection and manipulation,
history, patch generation and more. You should be able to do most
fundamental git operations with this library.
</p>
<p>
This module provides the basic functions to open a git reference to work
with. You can open a working directory, open a bare repository, initialize
a new repo or clone an existing remote repository.
</p>
<table>
<tr><td valign="top"><a href="Git/Author.html">Author</a>:</td><td>Scott Chacon (<a href="mailto:schacon@gmail.com">schacon@gmail.com</a>)

</td></tr>
<tr><td valign="top">License:</td><td>MIT License

</td></tr>
</table>

    </div>


   </div>

    <div id="method-list">
      <h3 class="section-bar">Methods</h3>

      <div class="name-list">
      <a href="#M000001">bare</a>&nbsp;&nbsp;
      <a href="#M000004">clone</a>&nbsp;&nbsp;
      <a href="#M000003">init</a>&nbsp;&nbsp;
      <a href="#M000002">open</a>&nbsp;&nbsp;
      </div>
    </div>

  </div>


    <!-- if includes -->

    <div id="section">

    <div id="class-list">
      <h3 class="section-bar">Classes and Modules</h3>

      Class <a href="Git/Author.html" class="link">Git::Author</a><br />
Class <a href="Git/Base.html" class="link">Git::Base</a><br />
Class <a href="Git/Branch.html" class="link">Git::Branch</a><br />
Class <a href="Git/Branches.html" class="link">Git::Branches</a><br />
Class <a href="Git/Diff.html" class="link">Git::Diff</a><br />
Class <a href="Git/GitExecuteError.html" class="link">Git::GitExecuteError</a><br />
Class <a href="Git/GitTagNameDoesNotExist.html" class="link">Git::GitTagNameDoesNotExist</a><br />
Class <a href="Git/Index.html" class="link">Git::Index</a><br />
Class <a href="Git/Lib.html" class="link">Git::Lib</a><br />
Class <a href="Git/Log.html" class="link">Git::Log</a><br />
Class <a href="Git/Object.html" class="link">Git::Object</a><br />
Class <a href="Git/Path.html" class="link">Git::Path</a><br />
Class <a href="Git/Remote.html" class="link">Git::Remote</a><br />
Class <a href="Git/Repository.html" class="link">Git::Repository</a><br />
Class <a href="Git/Status.html" class="link">Git::Status</a><br />
Class <a href="Git/WorkingDirectory.html" class="link">Git::WorkingDirectory</a><br />

    </div>

    <div id="constants-list">
      <h3 class="section-bar">Constants</h3>

      <div class="name-list">
        <table summary="Constants">
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">VERSION</td>
          <td>=</td>
          <td class="context-item-value">'1.0.3'</td>
        </tr>
        </table>
      </div>
    </div>



      


    <!-- if method_list -->
    <div id="methods">
      <h3 class="section-bar">Public Class methods</h3>

      <div id="method-M000001" class="method-detail">
        <a name="M000001"></a>

        <div class="method-heading">
          <a href="#M000001" class="method-signature">
          <span class="method-name">bare</span><span class="method-args">(git_dir)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
open a bare repository
</p>
<p>
this takes the path to a bare git repo it expects not to be able to use a
working directory so you can&#8217;t checkout stuff, commit things, etc.
but you can do most read operations
</p>
          <p><a class="source-toggle" href="#"
            onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
          <div class="method-source-code" id="M000001-source">
<pre>
<span class="ruby-comment cmt"># File lib/git.rb, line 51</span>
  <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>)
    <span class="ruby-constant">Base</span>.<span class="ruby-identifier">bare</span>(<span class="ruby-identifier">git_dir</span>)
  <span class="ruby-keyword kw">end</span>
</pre>
          </div>
        </div>
      </div>

      <div id="method-M000004" class="method-detail">
        <a name="M000004"></a>

        <div class="method-heading">
          <a href="#M000004" class="method-signature">
          <span class="method-name">clone</span><span class="method-args">(repository, name, options = {})</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
clones a remote repository
</p>
<p>
options
</p>
<pre>
  :bare =&gt; true (does a bare clone)
  :repository =&gt; '/path/to/alt_git_dir'
  :index =&gt; '/path/to/alt_index_file'
</pre>
<p>
example
</p>
<pre>
 Git.clone('git://repo.or.cz/rubygit.git', 'clone.git', :bare =&gt; true)
</pre>
          <p><a class="source-toggle" href="#"
            onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
          <div class="method-source-code" id="M000004-source">
<pre>
<span class="ruby-comment cmt"># File lib/git.rb, line 88</span>
  <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> = {})
    <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>)
  <span class="ruby-keyword kw">end</span>
</pre>
          </div>
        </div>
      </div>

      <div id="method-M000003" class="method-detail">
        <a name="M000003"></a>

        <div class="method-heading">
          <a href="#M000003" class="method-signature">
          <span class="method-name">init</span><span class="method-args">(working_dir = '.', options = {})</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
initialize a new git repository, defaults to the current working directory
</p>
<p>
options
</p>
<pre>
  :repository =&gt; '/path/to/alt_git_dir'
  :index =&gt; '/path/to/alt_index_file'
</pre>
          <p><a class="source-toggle" href="#"
            onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
          <div class="method-source-code" id="M000003-source">
<pre>
<span class="ruby-comment cmt"># File lib/git.rb, line 74</span>
  <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> = {})
    <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>)
  <span class="ruby-keyword kw">end</span>
</pre>
          </div>
        </div>
      </div>

      <div id="method-M000002" class="method-detail">
        <a name="M000002"></a>

        <div class="method-heading">
          <a href="#M000002" class="method-signature">
          <span class="method-name">open</span><span class="method-args">(working_dir, options = {})</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
open an existing git working directory
</p>
<p>
this will most likely be the most common way to create a git reference,
referring to a working directory. if not provided in the options, the
library will assume your git_dir and index are in the default place (.git/,
.git/index)
</p>
<p>
options
</p>
<pre>
  :repository =&gt; '/path/to/alt_git_dir'
  :index =&gt; '/path/to/alt_index_file'
</pre>
          <p><a class="source-toggle" href="#"
            onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
          <div class="method-source-code" id="M000002-source">
<pre>
<span class="ruby-comment cmt"># File lib/git.rb, line 65</span>
  <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> = {})
    <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>)
  <span class="ruby-keyword kw">end</span>
</pre>
          </div>
        </div>
      </div>


    </div>


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>