1 <?xml version=
"1.0" encoding=
"iso-8859-1"?>
3 PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
6 <html xmlns=
"http://www.w3.org/1999/xhtml" xml:
lang=
"en" lang=
"en">
8 <title>Class: Git::Branch
</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">
15 function popupCode( url ) {
16 window.open(url,
"Code",
"resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
19 function toggleCode( id ) {
20 if ( document.getElementById )
21 elem = document.getElementById( id );
22 else if ( document.all )
23 elem = eval(
"document.all." + id );
27 elemStyle = elem.style;
29 if ( elemStyle.display !=
"block" ) {
30 elemStyle.display =
"block"
32 elemStyle.display =
"none"
38 // Make codeblocks hidden by default
39 document.writeln(
"<style type=\"text/css\
">div.method-source-code { display: none }</style>" )
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::Branch
</td>
55 <tr class=
"top-aligned-row">
56 <td><strong>In:
</strong></td>
58 <a href=
"../../files/lib/git/branch_rb.html">
65 <tr class=
"top-aligned-row">
66 <td><strong>Parent:
</strong></td>
75 <!-- banner header -->
77 <div id=
"bodyContent">
81 <div id=
"contextContent">
87 <div id=
"method-list">
88 <h3 class=
"section-bar">Methods
</h3>
90 <div class=
"name-list">
91 <a href=
"#M000072">checkout
</a>
92 <a href=
"#M000074">create
</a>
93 <a href=
"#M000076">current
</a>
94 <a href=
"#M000075">delete
</a>
95 <a href=
"#M000071">gcommit
</a>
96 <a href=
"#M000073">in_branch
</a>
97 <a href=
"#M000077">merge
</a>
98 <a href=
"#M000070">new
</a>
99 <a href=
"#M000078">to_a
</a>
100 <a href=
"#M000079">to_s
</a>
115 <div id=
"attribute-list">
116 <h3 class=
"section-bar">Attributes
</h3>
118 <div class=
"name-list">
120 <tr class=
"top-aligned-row context-row">
121 <td class=
"context-item-name">full
</td>
122 <td class=
"context-item-value"> [RW]
</td>
123 <td class=
"context-item-desc"></td>
125 <tr class=
"top-aligned-row context-row">
126 <td class=
"context-item-name">name
</td>
127 <td class=
"context-item-value"> [RW]
</td>
128 <td class=
"context-item-desc"></td>
130 <tr class=
"top-aligned-row context-row">
131 <td class=
"context-item-name">remote
</td>
132 <td class=
"context-item-value"> [RW]
</td>
133 <td class=
"context-item-desc"></td>
141 <!-- if method_list -->
143 <h3 class=
"section-bar">Public Class methods
</h3>
145 <div id=
"method-M000070" class=
"method-detail">
146 <a name=
"M000070"></a>
148 <div class=
"method-heading">
149 <a href=
"#M000070" class=
"method-signature">
150 <span class=
"method-name">new
</span><span class=
"method-args">(base, name)
</span>
154 <div class=
"method-description">
155 <p><a class=
"source-toggle" href=
"#"
156 onclick=
"toggleCode('M000070-source');return false;">[Source]
</a></p>
157 <div class=
"method-source-code" id=
"M000070-source">
159 <span class=
"ruby-comment cmt"># File lib/git/branch.rb, line
9</span>
160 <span class=
"ruby-keyword kw">def
</span> <span class=
"ruby-identifier">initialize
</span>(
<span class=
"ruby-identifier">base
</span>,
<span class=
"ruby-identifier">name
</span>)
161 <span class=
"ruby-ivar">@remote
</span> =
<span class=
"ruby-keyword kw">nil
</span>
162 <span class=
"ruby-ivar">@full
</span> =
<span class=
"ruby-identifier">name
</span>
163 <span class=
"ruby-ivar">@base
</span> =
<span class=
"ruby-identifier">base
</span>
165 <span class=
"ruby-identifier">parts
</span> =
<span class=
"ruby-identifier">name
</span>.
<span class=
"ruby-identifier">split
</span>(
<span class=
"ruby-value str">'/'
</span>)
166 <span class=
"ruby-keyword kw">if
</span> <span class=
"ruby-identifier">parts
</span>[
<span class=
"ruby-value">1</span>]
167 <span class=
"ruby-ivar">@remote
</span> =
<span class=
"ruby-constant">Git
</span><span class=
"ruby-operator">::
</span><span class=
"ruby-constant">Remote
</span>.
<span class=
"ruby-identifier">new
</span>(
<span class=
"ruby-ivar">@base
</span>,
<span class=
"ruby-identifier">parts
</span>[
<span class=
"ruby-value">0</span>])
168 <span class=
"ruby-ivar">@name
</span> =
<span class=
"ruby-identifier">parts
</span>[
<span class=
"ruby-value">1</span>]
169 <span class=
"ruby-keyword kw">else
</span>
170 <span class=
"ruby-ivar">@name
</span> =
<span class=
"ruby-identifier">parts
</span>[
<span class=
"ruby-value">0</span>]
171 <span class=
"ruby-keyword kw">end
</span>
172 <span class=
"ruby-keyword kw">end
</span>
178 <h3 class=
"section-bar">Public Instance methods
</h3>
180 <div id=
"method-M000072" class=
"method-detail">
181 <a name=
"M000072"></a>
183 <div class=
"method-heading">
184 <a href=
"#M000072" class=
"method-signature">
185 <span class=
"method-name">checkout
</span><span class=
"method-args">()
</span>
189 <div class=
"method-description">
190 <p><a class=
"source-toggle" href=
"#"
191 onclick=
"toggleCode('M000072-source');return false;">[Source]
</a></p>
192 <div class=
"method-source-code" id=
"M000072-source">
194 <span class=
"ruby-comment cmt"># File lib/git/branch.rb, line
28</span>
195 <span class=
"ruby-keyword kw">def
</span> <span class=
"ruby-identifier">checkout
</span>
196 <span class=
"ruby-identifier">check_if_create
</span>
197 <span class=
"ruby-ivar">@base
</span>.
<span class=
"ruby-identifier">checkout
</span>(
<span class=
"ruby-ivar">@name
</span>)
198 <span class=
"ruby-keyword kw">end
</span>
204 <div id=
"method-M000074" class=
"method-detail">
205 <a name=
"M000074"></a>
207 <div class=
"method-heading">
208 <a href=
"#M000074" class=
"method-signature">
209 <span class=
"method-name">create
</span><span class=
"method-args">()
</span>
213 <div class=
"method-description">
214 <p><a class=
"source-toggle" href=
"#"
215 onclick=
"toggleCode('M000074-source');return false;">[Source]
</a></p>
216 <div class=
"method-source-code" id=
"M000074-source">
218 <span class=
"ruby-comment cmt"># File lib/git/branch.rb, line
50</span>
219 <span class=
"ruby-keyword kw">def
</span> <span class=
"ruby-identifier">create
</span>
220 <span class=
"ruby-identifier">check_if_create
</span>
221 <span class=
"ruby-keyword kw">end
</span>
227 <div id=
"method-M000076" class=
"method-detail">
228 <a name=
"M000076"></a>
230 <div class=
"method-heading">
231 <a href=
"#M000076" class=
"method-signature">
232 <span class=
"method-name">current
</span><span class=
"method-args">()
</span>
236 <div class=
"method-description">
237 <p><a class=
"source-toggle" href=
"#"
238 onclick=
"toggleCode('M000076-source');return false;">[Source]
</a></p>
239 <div class=
"method-source-code" id=
"M000076-source">
241 <span class=
"ruby-comment cmt"># File lib/git/branch.rb, line
58</span>
242 <span class=
"ruby-keyword kw">def
</span> <span class=
"ruby-identifier">current
</span>
243 <span class=
"ruby-identifier">determine_current
</span>
244 <span class=
"ruby-keyword kw">end
</span>
250 <div id=
"method-M000075" class=
"method-detail">
251 <a name=
"M000075"></a>
253 <div class=
"method-heading">
254 <a href=
"#M000075" class=
"method-signature">
255 <span class=
"method-name">delete
</span><span class=
"method-args">()
</span>
259 <div class=
"method-description">
260 <p><a class=
"source-toggle" href=
"#"
261 onclick=
"toggleCode('M000075-source');return false;">[Source]
</a></p>
262 <div class=
"method-source-code" id=
"M000075-source">
264 <span class=
"ruby-comment cmt"># File lib/git/branch.rb, line
54</span>
265 <span class=
"ruby-keyword kw">def
</span> <span class=
"ruby-identifier">delete
</span>
266 <span class=
"ruby-ivar">@base
</span>.
<span class=
"ruby-identifier">lib
</span>.
<span class=
"ruby-identifier">branch_delete
</span>(
<span class=
"ruby-ivar">@name
</span>)
267 <span class=
"ruby-keyword kw">end
</span>
273 <div id=
"method-M000071" class=
"method-detail">
274 <a name=
"M000071"></a>
276 <div class=
"method-heading">
277 <a href=
"#M000071" class=
"method-signature">
278 <span class=
"method-name">gcommit
</span><span class=
"method-args">()
</span>
282 <div class=
"method-description">
283 <p><a class=
"source-toggle" href=
"#"
284 onclick=
"toggleCode('M000071-source');return false;">[Source]
</a></p>
285 <div class=
"method-source-code" id=
"M000071-source">
287 <span class=
"ruby-comment cmt"># File lib/git/branch.rb, line
23</span>
288 <span class=
"ruby-keyword kw">def
</span> <span class=
"ruby-identifier">gcommit
</span>
289 <span class=
"ruby-ivar">@gcommit
</span> =
<span class=
"ruby-ivar">@base
</span>.
<span class=
"ruby-identifier">object
</span>(
<span class=
"ruby-identifier">name
</span>)
<span class=
"ruby-keyword kw">if
</span> <span class=
"ruby-operator">!
</span><span class=
"ruby-ivar">@gcommit
</span>
290 <span class=
"ruby-ivar">@gcommit
</span>
291 <span class=
"ruby-keyword kw">end
</span>
297 <div id=
"method-M000073" class=
"method-detail">
298 <a name=
"M000073"></a>
300 <div class=
"method-heading">
301 <a href=
"#M000073" class=
"method-signature">
302 <span class=
"method-name">in_branch
</span><span class=
"method-args">(message = 'in branch work') {|| ...}
</span>
306 <div class=
"method-description">
308 g.branch(
‘new_branch
’).
<a
309 href=
"Branch.html#M000073">in_branch
</a> do
314 return true # auto commits and switches back
319 <p><a class=
"source-toggle" href=
"#"
320 onclick=
"toggleCode('M000073-source');return false;">[Source]
</a></p>
321 <div class=
"method-source-code" id=
"M000073-source">
323 <span class=
"ruby-comment cmt"># File lib/git/branch.rb, line
39</span>
324 <span class=
"ruby-keyword kw">def
</span> <span class=
"ruby-identifier">in_branch
</span> (
<span class=
"ruby-identifier">message
</span> =
<span class=
"ruby-value str">'in branch work'
</span>)
325 <span class=
"ruby-identifier">old_current
</span> =
<span class=
"ruby-ivar">@base
</span>.
<span class=
"ruby-identifier">lib
</span>.
<span class=
"ruby-identifier">branch_current
</span>
326 <span class=
"ruby-identifier">checkout
</span>
327 <span class=
"ruby-keyword kw">if
</span> <span class=
"ruby-keyword kw">yield
</span>
328 <span class=
"ruby-ivar">@base
</span>.
<span class=
"ruby-identifier">commit_all
</span>(
<span class=
"ruby-identifier">message
</span>)
329 <span class=
"ruby-keyword kw">else
</span>
330 <span class=
"ruby-ivar">@base
</span>.
<span class=
"ruby-identifier">reset_hard
</span>
331 <span class=
"ruby-keyword kw">end
</span>
332 <span class=
"ruby-ivar">@base
</span>.
<span class=
"ruby-identifier">checkout
</span>(
<span class=
"ruby-identifier">old_current
</span>)
333 <span class=
"ruby-keyword kw">end
</span>
339 <div id=
"method-M000077" class=
"method-detail">
340 <a name=
"M000077"></a>
342 <div class=
"method-heading">
343 <a href=
"#M000077" class=
"method-signature">
344 <span class=
"method-name">merge
</span><span class=
"method-args">(branch = nil, message = nil)
</span>
348 <div class=
"method-description">
349 <p><a class=
"source-toggle" href=
"#"
350 onclick=
"toggleCode('M000077-source');return false;">[Source]
</a></p>
351 <div class=
"method-source-code" id=
"M000077-source">
353 <span class=
"ruby-comment cmt"># File lib/git/branch.rb, line
62</span>
354 <span class=
"ruby-keyword kw">def
</span> <span class=
"ruby-identifier">merge
</span>(
<span class=
"ruby-identifier">branch
</span> =
<span class=
"ruby-keyword kw">nil
</span>,
<span class=
"ruby-identifier">message
</span> =
<span class=
"ruby-keyword kw">nil
</span>)
355 <span class=
"ruby-keyword kw">if
</span> <span class=
"ruby-identifier">branch
</span>
356 <span class=
"ruby-identifier">in_branch
</span> <span class=
"ruby-keyword kw">do
</span>
357 <span class=
"ruby-ivar">@base
</span>.
<span class=
"ruby-identifier">merge
</span>(
<span class=
"ruby-identifier">branch
</span>,
<span class=
"ruby-identifier">message
</span>)
358 <span class=
"ruby-keyword kw">false
</span>
359 <span class=
"ruby-keyword kw">end
</span>
360 <span class=
"ruby-comment cmt"># merge a branch into this one
</span>
361 <span class=
"ruby-keyword kw">else
</span>
362 <span class=
"ruby-comment cmt"># merge this branch into the current one
</span>
363 <span class=
"ruby-ivar">@base
</span>.
<span class=
"ruby-identifier">merge
</span>(
<span class=
"ruby-ivar">@name
</span>)
364 <span class=
"ruby-keyword kw">end
</span>
365 <span class=
"ruby-keyword kw">end
</span>
371 <div id=
"method-M000078" class=
"method-detail">
372 <a name=
"M000078"></a>
374 <div class=
"method-heading">
375 <a href=
"#M000078" class=
"method-signature">
376 <span class=
"method-name">to_a
</span><span class=
"method-args">()
</span>
380 <div class=
"method-description">
381 <p><a class=
"source-toggle" href=
"#"
382 onclick=
"toggleCode('M000078-source');return false;">[Source]
</a></p>
383 <div class=
"method-source-code" id=
"M000078-source">
385 <span class=
"ruby-comment cmt"># File lib/git/branch.rb, line
75</span>
386 <span class=
"ruby-keyword kw">def
</span> <span class=
"ruby-identifier">to_a
</span>
387 [
<span class=
"ruby-ivar">@full
</span>]
388 <span class=
"ruby-keyword kw">end
</span>
394 <div id=
"method-M000079" class=
"method-detail">
395 <a name=
"M000079"></a>
397 <div class=
"method-heading">
398 <a href=
"#M000079" class=
"method-signature">
399 <span class=
"method-name">to_s
</span><span class=
"method-args">()
</span>
403 <div class=
"method-description">
404 <p><a class=
"source-toggle" href=
"#"
405 onclick=
"toggleCode('M000079-source');return false;">[Source]
</a></p>
406 <div class=
"method-source-code" id=
"M000079-source">
408 <span class=
"ruby-comment cmt"># File lib/git/branch.rb, line
79</span>
409 <span class=
"ruby-keyword kw">def
</span> <span class=
"ruby-identifier">to_s
</span>
410 <span class=
"ruby-ivar">@full
</span>
411 <span class=
"ruby-keyword kw">end
</span>
424 <div id=
"validator-badges">
425 <p><small><a href=
"http://validator.w3.org/check/referer">[Validate]
</a></small></p>