doc/classes/Git/Remote.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::Remote</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::Remote</td>
  54         </tr>
  55         <tr class="top-aligned-row">
  56             <td><strong>In:</strong></td>
  57             <td>
  58                 <a href="../../files/lib/git/remote_rb.html">
  59                 lib/git/remote.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="Path.html">
  69                 Path
  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="#M000151">branch</a>&nbsp;&nbsp;
  92       <a href="#M000149">fetch</a>&nbsp;&nbsp;
  93       <a href="#M000150">merge</a>&nbsp;&nbsp;
  94       <a href="#M000147">new</a>&nbsp;&nbsp;
  95       <a href="#M000148">remove</a>&nbsp;&nbsp;
  96       <a href="#M000152">remove</a>&nbsp;&nbsp;
  97       <a href="#M000153">to_s</a>&nbsp;&nbsp;
  98       </div>
  99     </div>
 100
 101   </div>
 102
 103
 104     <!-- if includes -->
 105
 106     <div id="section">
 107
 108
 109
 110
 111
 112     <div id="attribute-list">
 113       <h3 class="section-bar">Attributes</h3>
 114
 115       <div class="name-list">
 116         <table>
 117         <tr class="top-aligned-row context-row">
 118           <td class="context-item-name">fetch_opts</td>
 119           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 120           <td class="context-item-desc"></td>
 121         </tr>
 122         <tr class="top-aligned-row context-row">
 123           <td class="context-item-name">name</td>
 124           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 125           <td class="context-item-desc"></td>
 126         </tr>
 127         <tr class="top-aligned-row context-row">
 128           <td class="context-item-name">url</td>
 129           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 130           <td class="context-item-desc"></td>
 131         </tr>
 132         </table>
 133       </div>
 134     </div>
 135
 136
 137
 138     <!-- if method_list -->
 139     <div id="methods">
 140       <h3 class="section-bar">Public Class methods</h3>
 141
 142       <div id="method-M000147" class="method-detail">
 143         <a name="M000147"></a>
 144
 145         <div class="method-heading">
 146           <a href="#M000147" class="method-signature">
 147           <span class="method-name">new</span><span class="method-args">(base, name)</span>
 148           </a>
 149         </div>
 150
 151         <div class="method-description">
 152           <p><a class="source-toggle" href="#"
 153             onclick="toggleCode('M000147-source');return false;">[Source]</a></p>
 154           <div class="method-source-code" id="M000147-source">
 155 <pre>
 156 <span class="ruby-comment cmt"># File lib/git/remote.rb, line 8</span>
 157     <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>)
 158       <span class="ruby-ivar">@base</span> = <span class="ruby-identifier">base</span>
 159       <span class="ruby-identifier">config</span> = <span class="ruby-ivar">@base</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">config_remote</span>(<span class="ruby-identifier">name</span>)
 160       <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
 161       <span class="ruby-ivar">@url</span> = <span class="ruby-identifier">config</span>[<span class="ruby-value str">'url'</span>]
 162       <span class="ruby-ivar">@fetch_opts</span> = <span class="ruby-identifier">config</span>[<span class="ruby-value str">'fetch'</span>]
 163     <span class="ruby-keyword kw">end</span>
 164 </pre>
 165           </div>
 166         </div>
 167       </div>
 168
 169       <h3 class="section-bar">Public Instance methods</h3>
 170
 171       <div id="method-M000151" class="method-detail">
 172         <a name="M000151"></a>
 173
 174         <div class="method-heading">
 175           <a href="#M000151" class="method-signature">
 176           <span class="method-name">branch</span><span class="method-args">(branch = 'master')</span>
 177           </a>
 178         </div>
 179
 180         <div class="method-description">
 181           <p><a class="source-toggle" href="#"
 182             onclick="toggleCode('M000151-source');return false;">[Source]</a></p>
 183           <div class="method-source-code" id="M000151-source">
 184 <pre>
 185 <span class="ruby-comment cmt"># File lib/git/remote.rb, line 29</span>
 186     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">branch</span>(<span class="ruby-identifier">branch</span> = <span class="ruby-value str">'master'</span>)
 187       <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Branch</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@base</span>, <span class="ruby-node">&quot;#{@name}/#{branch}&quot;</span>)
 188     <span class="ruby-keyword kw">end</span>
 189 </pre>
 190           </div>
 191         </div>
 192       </div>
 193
 194       <div id="method-M000149" class="method-detail">
 195         <a name="M000149"></a>
 196
 197         <div class="method-heading">
 198           <a href="#M000149" class="method-signature">
 199           <span class="method-name">fetch</span><span class="method-args">()</span>
 200           </a>
 201         </div>
 202
 203         <div class="method-description">
 204           <p><a class="source-toggle" href="#"
 205             onclick="toggleCode('M000149-source');return false;">[Source]</a></p>
 206           <div class="method-source-code" id="M000149-source">
 207 <pre>
 208 <span class="ruby-comment cmt"># File lib/git/remote.rb, line 20</span>
 209     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fetch</span>
 210       <span class="ruby-ivar">@base</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-ivar">@name</span>)
 211     <span class="ruby-keyword kw">end</span>
 212 </pre>
 213           </div>
 214         </div>
 215       </div>
 216
 217       <div id="method-M000150" class="method-detail">
 218         <a name="M000150"></a>
 219
 220         <div class="method-heading">
 221           <a href="#M000150" class="method-signature">
 222           <span class="method-name">merge</span><span class="method-args">(branch = 'master')</span>
 223           </a>
 224         </div>
 225
 226         <div class="method-description">
 227           <p>
 228 merge this remote locally
 229 </p>
 230           <p><a class="source-toggle" href="#"
 231             onclick="toggleCode('M000150-source');return false;">[Source]</a></p>
 232           <div class="method-source-code" id="M000150-source">
 233 <pre>
 234 <span class="ruby-comment cmt"># File lib/git/remote.rb, line 25</span>
 235     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">merge</span>(<span class="ruby-identifier">branch</span> = <span class="ruby-value str">'master'</span>)
 236       <span class="ruby-ivar">@base</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-node">&quot;#{@name}/#{branch}&quot;</span>)
 237     <span class="ruby-keyword kw">end</span>
 238 </pre>
 239           </div>
 240         </div>
 241       </div>
 242
 243       <div id="method-M000148" class="method-detail">
 244         <a name="M000148"></a>
 245
 246         <div class="method-heading">
 247           <a href="#M000148" class="method-signature">
 248           <span class="method-name">remove</span><span class="method-args">()</span>
 249           </a>
 250         </div>
 251
 252         <div class="method-description">
 253           <p><a class="source-toggle" href="#"
 254             onclick="toggleCode('M000148-source');return false;">[Source]</a></p>
 255           <div class="method-source-code" id="M000148-source">
 256 <pre>
 257 <span class="ruby-comment cmt"># File lib/git/remote.rb, line 16</span>
 258     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">remove</span>
 259       <span class="ruby-ivar">@base</span>.<span class="ruby-identifier">remote_remove</span>(<span class="ruby-ivar">@name</span>)
 260     <span class="ruby-keyword kw">end</span>
 261 </pre>
 262           </div>
 263         </div>
 264       </div>
 265
 266       <div id="method-M000152" class="method-detail">
 267         <a name="M000152"></a>
 268
 269         <div class="method-heading">
 270           <a href="#M000152" class="method-signature">
 271           <span class="method-name">remove</span><span class="method-args">()</span>
 272           </a>
 273         </div>
 274
 275         <div class="method-description">
 276           <p><a class="source-toggle" href="#"
 277             onclick="toggleCode('M000152-source');return false;">[Source]</a></p>
 278           <div class="method-source-code" id="M000152-source">
 279 <pre>
 280 <span class="ruby-comment cmt"># File lib/git/remote.rb, line 33</span>
 281     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">remove</span>
 282       <span class="ruby-ivar">@base</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">remote_remove</span>(<span class="ruby-ivar">@name</span>)
 283     <span class="ruby-keyword kw">end</span>
 284 </pre>
 285           </div>
 286         </div>
 287       </div>
 288
 289       <div id="method-M000153" class="method-detail">
 290         <a name="M000153"></a>
 291
 292         <div class="method-heading">
 293           <a href="#M000153" class="method-signature">
 294           <span class="method-name">to_s</span><span class="method-args">()</span>
 295           </a>
 296         </div>
 297
 298         <div class="method-description">
 299           <p><a class="source-toggle" href="#"
 300             onclick="toggleCode('M000153-source');return false;">[Source]</a></p>
 301           <div class="method-source-code" id="M000153-source">
 302 <pre>
 303 <span class="ruby-comment cmt"># File lib/git/remote.rb, line 37</span>
 304     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
 305       <span class="ruby-ivar">@name</span>
 306     <span class="ruby-keyword kw">end</span>
 307 </pre>
 308           </div>
 309         </div>
 310       </div>
 311
 312
 313     </div>
 314
 315
 316   </div>
 317
 318
 319 <div id="validator-badges">
 320   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 321 </div>
 322
 323 </body>
 324 </html>