diff options
Diffstat (limited to 'doc/classes/Git/Base.html')
| -rw-r--r-- | doc/classes/Git/Base.html | 734 |
1 files changed, 452 insertions, 282 deletions
diff --git a/doc/classes/Git/Base.html b/doc/classes/Git/Base.html index 2a7fbce..9c994c6 100644 --- a/doc/classes/Git/Base.html +++ b/doc/classes/Git/Base.html @@ -88,48 +88,48 @@ <h3 class="section-bar">Methods</h3> <div class="name-list"> - <a href="#M000100">add</a> - <a href="#M000112">add_remote</a> - <a href="#M000115">add_tag</a> - <a href="#M000077">bare</a> - <a href="#M000095">branch</a> - <a href="#M000094">branches</a> - <a href="#M000085">chdir</a> - <a href="#M000106">checkout</a> - <a href="#M000080">clone</a> - <a href="#M000104">commit</a> - <a href="#M000105">commit_all</a> - <a href="#M000087">config</a> - <a href="#M000118">current_branch</a> - <a href="#M000099">diff</a> - <a href="#M000082">dir</a> - <a href="#M000107">fetch</a> - <a href="#M000091">gblob</a> - <a href="#M000090">gcommit</a> - <a href="#M000098">grep</a> - <a href="#M000089">gtree</a> - <a href="#M000084">index</a> - <a href="#M000079">init</a> - <a href="#M000097">lib</a> - <a href="#M000092">log</a> - <a href="#M000109">merge</a> - <a href="#M000081">new</a> - <a href="#M000088">object</a> - <a href="#M000078">open</a> - <a href="#M000110">pull</a> - <a href="#M000108">push</a> - <a href="#M000096">remote</a> - <a href="#M000111">remotes</a> - <a href="#M000101">remove</a> - <a href="#M000116">repack</a> - <a href="#M000083">repo</a> - <a href="#M000086">repo_size</a> - <a href="#M000102">reset</a> - <a href="#M000103">reset_hard</a> - <a href="#M000117">revparse</a> - <a href="#M000093">status</a> - <a href="#M000114">tag</a> - <a href="#M000113">tags</a> + <a href="#M000103">add</a> + <a href="#M000115">add_remote</a> + <a href="#M000118">add_tag</a> + <a href="#M000080">bare</a> + <a href="#M000098">branch</a> + <a href="#M000097">branches</a> + <a href="#M000088">chdir</a> + <a href="#M000109">checkout</a> + <a href="#M000083">clone</a> + <a href="#M000107">commit</a> + <a href="#M000108">commit_all</a> + <a href="#M000090">config</a> + <a href="#M000121">current_branch</a> + <a href="#M000102">diff</a> + <a href="#M000085">dir</a> + <a href="#M000110">fetch</a> + <a href="#M000094">gblob</a> + <a href="#M000093">gcommit</a> + <a href="#M000101">grep</a> + <a href="#M000092">gtree</a> + <a href="#M000087">index</a> + <a href="#M000082">init</a> + <a href="#M000100">lib</a> + <a href="#M000095">log</a> + <a href="#M000112">merge</a> + <a href="#M000084">new</a> + <a href="#M000091">object</a> + <a href="#M000081">open</a> + <a href="#M000113">pull</a> + <a href="#M000111">push</a> + <a href="#M000099">remote</a> + <a href="#M000114">remotes</a> + <a href="#M000104">remove</a> + <a href="#M000119">repack</a> + <a href="#M000086">repo</a> + <a href="#M000089">repo_size</a> + <a href="#M000105">reset</a> + <a href="#M000106">reset_hard</a> + <a href="#M000120">revparse</a> + <a href="#M000096">status</a> + <a href="#M000117">tag</a> + <a href="#M000116">tags</a> </div> </div> @@ -151,11 +151,11 @@ <div id="methods"> <h3 class="section-bar">Public Class methods</h3> - <div id="method-M000077" class="method-detail"> - <a name="M000077"></a> + <div id="method-M000080" class="method-detail"> + <a name="M000080"></a> <div class="method-heading"> - <a href="#M000077" class="method-signature"> + <a href="#M000080" class="method-signature"> <span class="method-name">bare</span><span class="method-args">(git_dir)</span> </a> </div> @@ -166,8 +166,8 @@ opens a bare <a href="../Git.html">Git</a> <a href="Repository.html">Repository</a> - no working directory options </p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000077-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000077-source"> + onclick="toggleCode('M000080-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000080-source"> <pre> <span class="ruby-comment cmt"># File lib/git/base.rb, line 10</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>) @@ -178,11 +178,11 @@ href="Repository.html">Repository</a> - no working directory options </div> </div> - <div id="method-M000080" class="method-detail"> - <a name="M000080"></a> + <div id="method-M000083" class="method-detail"> + <a name="M000083"></a> <div class="method-heading"> - <a href="#M000080" class="method-signature"> + <a href="#M000083" class="method-signature"> <span class="method-name">clone</span><span class="method-args">(repository, name, opts = {})</span> </a> </div> @@ -207,8 +207,8 @@ options: :index_file </pre> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000080-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000080-source"> + onclick="toggleCode('M000083-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000083-source"> <pre> <span class="ruby-comment cmt"># File lib/git/base.rb, line 58</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">opts</span> = {}) @@ -220,11 +220,11 @@ options: </div> </div> - <div id="method-M000079" class="method-detail"> - <a name="M000079"></a> + <div id="method-M000082" class="method-detail"> + <a name="M000082"></a> <div class="method-heading"> - <a href="#M000079" class="method-signature"> + <a href="#M000082" class="method-signature"> <span class="method-name">init</span><span class="method-args">(working_dir, opts = {})</span> </a> </div> @@ -241,8 +241,8 @@ options: :index_file </pre> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000079-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000079-source"> + onclick="toggleCode('M000082-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000082-source"> <pre> <span class="ruby-comment cmt"># File lib/git/base.rb, line 29</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-identifier">opts</span> = {}) @@ -265,19 +265,19 @@ options: </div> </div> - <div id="method-M000081" class="method-detail"> - <a name="M000081"></a> + <div id="method-M000084" class="method-detail"> + <a name="M000084"></a> <div class="method-heading"> - <a href="#M000081" class="method-signature"> + <a href="#M000084" class="method-signature"> <span class="method-name">new</span><span class="method-args">(options = {})</span> </a> </div> <div class="method-description"> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000081-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000081-source"> + onclick="toggleCode('M000084-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000084-source"> <pre> <span class="ruby-comment cmt"># File lib/git/base.rb, line 63</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">options</span> = {}) @@ -295,11 +295,11 @@ options: </div> </div> - <div id="method-M000078" class="method-detail"> - <a name="M000078"></a> + <div id="method-M000081" class="method-detail"> + <a name="M000081"></a> <div class="method-heading"> - <a href="#M000078" class="method-signature"> + <a href="#M000081" class="method-signature"> <span class="method-name">open</span><span class="method-args">(working_dir, opts={})</span> </a> </div> @@ -310,8 +310,8 @@ opens a new <a href="../Git.html">Git</a> Project from a working directory you can specify non-standard git_dir and index file in the options </p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000078-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000078-source"> + onclick="toggleCode('M000081-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000081-source"> <pre> <span class="ruby-comment cmt"># File lib/git/base.rb, line 16</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">opts</span>={}) @@ -327,11 +327,11 @@ you can specify non-standard git_dir and index file in the options <h3 class="section-bar">Public Instance methods</h3> - <div id="method-M000100" class="method-detail"> - <a name="M000100"></a> + <div id="method-M000103" class="method-detail"> + <a name="M000103"></a> <div class="method-heading"> - <a href="#M000100" class="method-signature"> + <a href="#M000103" class="method-signature"> <span class="method-name">add</span><span class="method-args">(path = '.')</span> </a> </div> @@ -341,10 +341,10 @@ you can specify non-standard git_dir and index file in the options adds files from the working directory to the git repository </p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000100-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000100-source"> + onclick="toggleCode('M000103-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000103-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 162</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 212</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add</span>(<span class="ruby-identifier">path</span> = <span class="ruby-value str">'.'</span>) <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">path</span>) <span class="ruby-keyword kw">end</span> @@ -353,21 +353,30 @@ adds files from the working directory to the git repository </div> </div> - <div id="method-M000112" class="method-detail"> - <a name="M000112"></a> + <div id="method-M000115" class="method-detail"> + <a name="M000115"></a> <div class="method-heading"> - <a href="#M000112" class="method-signature"> + <a href="#M000115" class="method-signature"> <span class="method-name">add_remote</span><span class="method-args">(name, url, opts = {})</span> </a> </div> <div class="method-description"> + <p> +adds a new remote to this repository url can be a git url or a <a +href="Base.html">Git::Base</a> object if it’s a local reference +</p> +<pre> + @git.add_remote('scotts_git', 'git://repo.or.cz/rubygit.git') + @git.fetch('scotts_git') + @git.merge('scotts_git/master') +</pre> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000112-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000112-source"> + onclick="toggleCode('M000115-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000115-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 213</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 290</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_remote</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">url</span>, <span class="ruby-identifier">opts</span> = {}) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">url</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>) <span class="ruby-identifier">url</span> = <span class="ruby-identifier">url</span>.<span class="ruby-identifier">repo</span>.<span class="ruby-identifier">path</span> @@ -380,21 +389,24 @@ adds files from the working directory to the git repository </div> </div> - <div id="method-M000115" class="method-detail"> - <a name="M000115"></a> + <div id="method-M000118" class="method-detail"> + <a name="M000118"></a> <div class="method-heading"> - <a href="#M000115" class="method-signature"> + <a href="#M000118" class="method-signature"> <span class="method-name">add_tag</span><span class="method-args">(tag_name)</span> </a> </div> <div class="method-description"> + <p> +creates a new git tag (Git::Tag) +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000115-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000115-source"> + onclick="toggleCode('M000118-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000118-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 229</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 309</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_tag</span>(<span class="ruby-identifier">tag_name</span>) <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">tag</span>(<span class="ruby-identifier">tag_name</span>) <span class="ruby-identifier">tag</span>(<span class="ruby-identifier">tag_name</span>) @@ -404,21 +416,24 @@ adds files from the working directory to the git repository </div> </div> - <div id="method-M000095" class="method-detail"> - <a name="M000095"></a> + <div id="method-M000098" class="method-detail"> + <a name="M000098"></a> <div class="method-heading"> - <a href="#M000095" class="method-signature"> + <a href="#M000098" class="method-signature"> <span class="method-name">branch</span><span class="method-args">(branch_name = 'master')</span> </a> </div> <div class="method-description"> + <p> +returns a <a href="Branch.html">Git::Branch</a> object for branch_name +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000095-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000095-source"> + onclick="toggleCode('M000098-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000098-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 140</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 167</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">branch</span>(<span class="ruby-identifier">branch_name</span> = <span class="ruby-value str">'master'</span>) <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-keyword kw">self</span>, <span class="ruby-identifier">branch_name</span>) <span class="ruby-keyword kw">end</span> @@ -427,21 +442,25 @@ adds files from the working directory to the git repository </div> </div> - <div id="method-M000094" class="method-detail"> - <a name="M000094"></a> + <div id="method-M000097" class="method-detail"> + <a name="M000097"></a> <div class="method-heading"> - <a href="#M000094" class="method-signature"> + <a href="#M000097" class="method-signature"> <span class="method-name">branches</span><span class="method-args">()</span> </a> </div> <div class="method-description"> + <p> +returns a <a href="Branches.html">Git::Branches</a> object of all the <a +href="Branch.html">Git::Branch</a> objects for this repo +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000094-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000094-source"> + onclick="toggleCode('M000097-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000097-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 136</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 162</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">branches</span> <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Branches</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>) <span class="ruby-keyword kw">end</span> @@ -450,21 +469,34 @@ adds files from the working directory to the git repository </div> </div> - <div id="method-M000085" class="method-detail"> - <a name="M000085"></a> + <div id="method-M000088" class="method-detail"> + <a name="M000088"></a> <div class="method-heading"> - <a href="#M000085" class="method-signature"> + <a href="#M000088" class="method-signature"> <span class="method-name">chdir</span><span class="method-args">() {|dir.path| ...}</span> </a> </div> <div class="method-description"> + <p> +changes current working directory for a block to the git working directory +</p> +<p> +example +</p> +<pre> + @git.chdir do + # write files + @git.add + @git.commit('message') + end +</pre> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000085-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000085-source"> + onclick="toggleCode('M000088-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000088-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 87</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 102</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">chdir</span> <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span>(<span class="ruby-identifier">dir</span>.<span class="ruby-identifier">path</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">dir</span>.<span class="ruby-identifier">path</span> @@ -475,21 +507,24 @@ adds files from the working directory to the git repository </div> </div> - <div id="method-M000106" class="method-detail"> - <a name="M000106"></a> + <div id="method-M000109" class="method-detail"> + <a name="M000109"></a> <div class="method-heading"> - <a href="#M000106" class="method-signature"> + <a href="#M000109" class="method-signature"> <span class="method-name">checkout</span><span class="method-args">(branch = 'master', opts = {})</span> </a> </div> <div class="method-description"> + <p> +checks out a branch as the new git working directory +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000106-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000106-source"> + onclick="toggleCode('M000109-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000109-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 188</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 246</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">checkout</span>(<span class="ruby-identifier">branch</span> = <span class="ruby-value str">'master'</span>, <span class="ruby-identifier">opts</span> = {}) <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">checkout</span>(<span class="ruby-identifier">branch</span>, <span class="ruby-identifier">opts</span>) <span class="ruby-keyword kw">end</span> @@ -498,21 +533,24 @@ adds files from the working directory to the git repository </div> </div> - <div id="method-M000104" class="method-detail"> - <a name="M000104"></a> + <div id="method-M000107" class="method-detail"> + <a name="M000107"></a> <div class="method-heading"> - <a href="#M000104" class="method-signature"> + <a href="#M000107" class="method-signature"> <span class="method-name">commit</span><span class="method-args">(message, opts = {})</span> </a> </div> <div class="method-description"> + <p> +commits all pending changes in the index file to the git repository +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000104-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000104-source"> + onclick="toggleCode('M000107-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000107-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 179</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 233</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">commit</span>(<span class="ruby-identifier">message</span>, <span class="ruby-identifier">opts</span> = {}) <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">commit</span>(<span class="ruby-identifier">message</span>, <span class="ruby-identifier">opts</span>) <span class="ruby-keyword kw">end</span> @@ -521,21 +559,26 @@ adds files from the working directory to the git repository </div> </div> - <div id="method-M000105" class="method-detail"> - <a name="M000105"></a> + <div id="method-M000108" class="method-detail"> + <a name="M000108"></a> <div class="method-heading"> - <a href="#M000105" class="method-signature"> + <a href="#M000108" class="method-signature"> <span class="method-name">commit_all</span><span class="method-args">(message, opts = {})</span> </a> </div> <div class="method-description"> + <p> +commits all pending changes in the index file to the git repository, but +automatically adds all modified files without having to explicitly calling +@git.add() on them. +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000105-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000105-source"> + onclick="toggleCode('M000108-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000108-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 183</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 240</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">commit_all</span>(<span class="ruby-identifier">message</span>, <span class="ruby-identifier">opts</span> = {}) <span class="ruby-identifier">opts</span> = {<span class="ruby-identifier">:add_all</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">opts</span>) <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">commit</span>(<span class="ruby-identifier">message</span>, <span class="ruby-identifier">opts</span>) @@ -545,11 +588,11 @@ adds files from the working directory to the git repository </div> </div> - <div id="method-M000087" class="method-detail"> - <a name="M000087"></a> + <div id="method-M000090" class="method-detail"> + <a name="M000090"></a> <div class="method-heading"> - <a href="#M000087" class="method-signature"> + <a href="#M000090" class="method-signature"> <span class="method-name">config</span><span class="method-args">(name = nil, value = nil)</span> </a> </div> @@ -562,10 +605,10 @@ value g.config(‘user.name’) # returns ‘Scott Chacon’ g.config # returns whole config hash </p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000087-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000087-source"> + onclick="toggleCode('M000090-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000090-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 105</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 121</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">config</span>(<span class="ruby-identifier">name</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">value</span> = <span class="ruby-keyword kw">nil</span>) <span class="ruby-keyword kw">if</span>(<span class="ruby-identifier">name</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">value</span>) <span class="ruby-comment cmt"># set value</span> @@ -583,21 +626,24 @@ Chacon’ g.config # returns whole config hash </div> </div> - <div id="method-M000118" class="method-detail"> - <a name="M000118"></a> + <div id="method-M000121" class="method-detail"> + <a name="M000121"></a> <div class="method-heading"> - <a href="#M000118" class="method-signature"> + <a href="#M000121" class="method-signature"> <span class="method-name">current_branch</span><span class="method-args">()</span> </a> </div> <div class="method-description"> + <p> +returns the name of the branch the working directory is currently on +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000118-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000118-source"> + onclick="toggleCode('M000121-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000121-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 244</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 330</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">current_branch</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">branch_current</span> <span class="ruby-keyword kw">end</span> @@ -606,21 +652,24 @@ Chacon’ g.config # returns whole config hash </div> </div> - <div id="method-M000099" class="method-detail"> - <a name="M000099"></a> + <div id="method-M000102" class="method-detail"> + <a name="M000102"></a> <div class="method-heading"> - <a href="#M000099" class="method-signature"> + <a href="#M000102" class="method-signature"> <span class="method-name">diff</span><span class="method-args">(objectish = 'HEAD', obj2 = nil)</span> </a> </div> <div class="method-description"> + <p> +returns a <a href="Diff.html">Git::Diff</a> object +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000099-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000099-source"> + onclick="toggleCode('M000102-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000102-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 157</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 207</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">diff</span>(<span class="ruby-identifier">objectish</span> = <span class="ruby-value str">'HEAD'</span>, <span class="ruby-identifier">obj2</span> = <span class="ruby-keyword kw">nil</span>) <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Diff</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">objectish</span>, <span class="ruby-identifier">obj2</span>) <span class="ruby-keyword kw">end</span> @@ -629,21 +678,28 @@ Chacon’ g.config # returns whole config hash </div> </div> - <div id="method-M000082" class="method-detail"> - <a name="M000082"></a> + <div id="method-M000085" class="method-detail"> + <a name="M000085"></a> <div class="method-heading"> - <a href="#M000082" class="method-signature"> + <a href="#M000085" class="method-signature"> <span class="method-name">dir</span><span class="method-args">()</span> </a> </div> <div class="method-description"> + <p> +returns a reference to the working directory +</p> +<pre> + @git.dir.path + @git.dir.writeable? +</pre> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000082-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000082-source"> + onclick="toggleCode('M000085-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000085-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 75</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 78</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dir</span> <span class="ruby-ivar">@working_directory</span> <span class="ruby-keyword kw">end</span> @@ -652,21 +708,25 @@ Chacon’ g.config # returns whole config hash </div> </div> - <div id="method-M000107" class="method-detail"> - <a name="M000107"></a> + <div id="method-M000110" class="method-detail"> + <a name="M000110"></a> <div class="method-heading"> - <a href="#M000107" class="method-signature"> + <a href="#M000110" class="method-signature"> <span class="method-name">fetch</span><span class="method-args">(remote = 'origin')</span> </a> </div> <div class="method-description"> + <p> +fetches changes from a remote branch - this does not modify the working +directory, it just gets the changes from the remote if there are any +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000107-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000107-source"> + onclick="toggleCode('M000110-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000110-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 192</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 252</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">remote</span> = <span class="ruby-value str">'origin'</span>) <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">remote</span>) <span class="ruby-keyword kw">end</span> @@ -675,8 +735,8 @@ Chacon’ g.config # returns whole config hash </div> </div> - <div id="method-M000091" class="method-detail"> - <a name="M000091"></a> + <div id="method-M000094" class="method-detail"> + <a name="M000094"></a> <div class="method-heading"> <span class="method-name">gblob</span><span class="method-args">(objectish)</span> @@ -684,13 +744,13 @@ Chacon’ g.config # returns whole config hash <div class="method-description"> <p> -Alias for <a href="Base.html#M000088">object</a> +Alias for <a href="Base.html#M000091">object</a> </p> </div> </div> - <div id="method-M000090" class="method-detail"> - <a name="M000090"></a> + <div id="method-M000093" class="method-detail"> + <a name="M000093"></a> <div class="method-heading"> <span class="method-name">gcommit</span><span class="method-args">(objectish)</span> @@ -698,26 +758,54 @@ Alias for <a href="Base.html#M000088">object</a> <div class="method-description"> <p> -Alias for <a href="Base.html#M000088">object</a> +Alias for <a href="Base.html#M000091">object</a> </p> </div> </div> - <div id="method-M000098" class="method-detail"> - <a name="M000098"></a> + <div id="method-M000101" class="method-detail"> + <a name="M000101"></a> <div class="method-heading"> - <a href="#M000098" class="method-signature"> + <a href="#M000101" class="method-signature"> <span class="method-name">grep</span><span class="method-args">(string)</span> </a> </div> <div class="method-description"> + <p> +will run a grep for ‘string’ on the HEAD of the git repository +</p> +<p> +to be more surgical in your grep, you can call grep() off a specific git +object. for example: +</p> +<pre> + @git.object("v2.3").grep('TODO') +</pre> +<p> +in any case, it returns a hash of arrays of the type: +</p> +<pre> + hsh[tree-ish] = [[line_no, match], [line_no, match2]] + hsh[tree-ish] = [[line_no, match], [line_no, match2]] +</pre> +<p> +so you might use it like this: +</p> +<pre> + @git.grep("TODO").each do |sha, arr| + puts "in blob #{sha}:" + arr.each do |match| + puts "\t line #{match[0]}: '#{match[1]}'" + end + end +</pre> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000098-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000098-source"> + onclick="toggleCode('M000101-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000101-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 153</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 202</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">grep</span>(<span class="ruby-identifier">string</span>) <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">object</span>(<span class="ruby-value str">'HEAD'</span>).<span class="ruby-identifier">grep</span>(<span class="ruby-identifier">string</span>) <span class="ruby-keyword kw">end</span> @@ -726,8 +814,8 @@ Alias for <a href="Base.html#M000088">object</a> </div> </div> - <div id="method-M000089" class="method-detail"> - <a name="M000089"></a> + <div id="method-M000092" class="method-detail"> + <a name="M000092"></a> <div class="method-heading"> <span class="method-name">gtree</span><span class="method-args">(objectish)</span> @@ -735,26 +823,29 @@ Alias for <a href="Base.html#M000088">object</a> <div class="method-description"> <p> -Alias for <a href="Base.html#M000088">object</a> +Alias for <a href="Base.html#M000091">object</a> </p> </div> </div> - <div id="method-M000084" class="method-detail"> - <a name="M000084"></a> + <div id="method-M000087" class="method-detail"> + <a name="M000087"></a> <div class="method-heading"> - <a href="#M000084" class="method-signature"> + <a href="#M000087" class="method-signature"> <span class="method-name">index</span><span class="method-args">()</span> </a> </div> <div class="method-description"> + <p> +returns reference to the git index file +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000084-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000084-source"> + onclick="toggleCode('M000087-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000087-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 83</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 89</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">index</span> <span class="ruby-ivar">@index</span> <span class="ruby-keyword kw">end</span> @@ -763,21 +854,27 @@ Alias for <a href="Base.html#M000088">object</a> </div> </div> - <div id="method-M000097" class="method-detail"> - <a name="M000097"></a> + <div id="method-M000100" class="method-detail"> + <a name="M000100"></a> <div class="method-heading"> - <a href="#M000097" class="method-signature"> + <a href="#M000100" class="method-signature"> <span class="method-name">lib</span><span class="method-args">()</span> </a> </div> <div class="method-description"> + <p> +this is a convenience method for accessing the class that wraps all the +actual ‘git’ forked system calls. At some point I hope to +replace the <a href="Lib.html">Git::Lib</a> class with one that uses native +methods or libgit C bindings +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000097-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000097-source"> + onclick="toggleCode('M000100-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000100-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 149</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 179</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">lib</span> <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Lib</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>) <span class="ruby-keyword kw">end</span> @@ -786,21 +883,24 @@ Alias for <a href="Base.html#M000088">object</a> </div> </div> - <div id="method-M000092" class="method-detail"> - <a name="M000092"></a> + <div id="method-M000095" class="method-detail"> + <a name="M000095"></a> <div class="method-heading"> - <a href="#M000092" class="method-signature"> + <a href="#M000095" class="method-signature"> <span class="method-name">log</span><span class="method-args">(count = 30)</span> </a> </div> <div class="method-description"> + <p> +returns a <a href="Log.html">Git::Log</a> object with count commits +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000092-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000092-source"> + onclick="toggleCode('M000095-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000095-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 128</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 152</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">count</span> = <span class="ruby-value">30</span>) <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Log</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">count</span>) <span class="ruby-keyword kw">end</span> @@ -809,21 +909,28 @@ Alias for <a href="Base.html#M000088">object</a> </div> </div> - <div id="method-M000109" class="method-detail"> - <a name="M000109"></a> + <div id="method-M000112" class="method-detail"> + <a name="M000112"></a> <div class="method-heading"> - <a href="#M000109" class="method-signature"> + <a href="#M000112" class="method-signature"> <span class="method-name">merge</span><span class="method-args">(branch, message = 'merge')</span> </a> </div> <div class="method-description"> + <p> +merges one or more branches into the current working branch +</p> +<p> +you can specify more than one branch to merge by passing an array of +branches +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000109-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000109-source"> + onclick="toggleCode('M000112-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000112-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 200</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 268</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">merge</span>(<span class="ruby-identifier">branch</span>, <span class="ruby-identifier">message</span> = <span class="ruby-value str">'merge'</span>) <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">branch</span>, <span class="ruby-identifier">message</span>) <span class="ruby-keyword kw">end</span> @@ -832,24 +939,32 @@ Alias for <a href="Base.html#M000088">object</a> </div> </div> - <div id="method-M000088" class="method-detail"> - <a name="M000088"></a> + <div id="method-M000091" class="method-detail"> + <a name="M000091"></a> <div class="method-heading"> - <a href="#M000088" class="method-signature"> + <a href="#M000091" class="method-signature"> <span class="method-name">object</span><span class="method-args">(objectish)</span> </a> </div> <div class="method-description"> <p> -factory methods +returns a <a href="Object.html">Git::Object</a> of the appropriate type you +can also call @git.gtree(‘tree’), but that’s just for +readability. If you call @git.gtree(‘HEAD’) it will still +return a <a href="Object/Commit.html">Git::Object::Commit</a> object. +</p> +<p> +@git.object calls a factory method that will run a rev-parse on the +objectish and determine the type of the object and return an appropriate +object for that type </p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000088-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000088-source"> + onclick="toggleCode('M000091-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000091-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 120</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 144</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">object</span>(<span class="ruby-identifier">objectish</span>) <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Object</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">objectish</span>) <span class="ruby-keyword kw">end</span> @@ -858,21 +973,25 @@ factory methods </div> </div> - <div id="method-M000110" class="method-detail"> - <a name="M000110"></a> + <div id="method-M000113" class="method-detail"> + <a name="M000113"></a> <div class="method-heading"> - <a href="#M000110" class="method-signature"> + <a href="#M000113" class="method-signature"> <span class="method-name">pull</span><span class="method-args">(remote = 'origin', branch = 'master', message = 'origin pull')</span> </a> </div> <div class="method-description"> + <p> +fetches a branch from a remote and merges it into the current working +branch +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000110-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000110-source"> + onclick="toggleCode('M000113-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000113-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 204</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 273</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pull</span>(<span class="ruby-identifier">remote</span> = <span class="ruby-value str">'origin'</span>, <span class="ruby-identifier">branch</span> = <span class="ruby-value str">'master'</span>, <span class="ruby-identifier">message</span> = <span class="ruby-value str">'origin pull'</span>) <span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">remote</span>) <span class="ruby-identifier">merge</span>(<span class="ruby-identifier">branch</span>, <span class="ruby-identifier">message</span>) @@ -882,21 +1001,29 @@ factory methods </div> </div> - <div id="method-M000108" class="method-detail"> - <a name="M000108"></a> + <div id="method-M000111" class="method-detail"> + <a name="M000111"></a> <div class="method-heading"> - <a href="#M000108" class="method-signature"> + <a href="#M000111" class="method-signature"> <span class="method-name">push</span><span class="method-args">(remote = 'origin', branch = 'master')</span> </a> </div> <div class="method-description"> + <p> +pushes changes to a remote repository - easiest if this is a cloned +repository, otherwise you may have to run something like this first to +setup the push parameters: +</p> +<pre> + @git.config('remote.remote-name.push', 'refs/heads/master:refs/heads/master') +</pre> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000108-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000108-source"> + onclick="toggleCode('M000111-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000111-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 196</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 261</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">push</span>(<span class="ruby-identifier">remote</span> = <span class="ruby-value str">'origin'</span>, <span class="ruby-identifier">branch</span> = <span class="ruby-value str">'master'</span>) <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">remote</span>, <span class="ruby-identifier">branch</span>) <span class="ruby-keyword kw">end</span> @@ -905,21 +1032,24 @@ factory methods </div> </div> - <div id="method-M000096" class="method-detail"> - <a name="M000096"></a> + <div id="method-M000099" class="method-detail"> + <a name="M000099"></a> <div class="method-heading"> - <a href="#M000096" class="method-signature"> + <a href="#M000099" class="method-signature"> <span class="method-name">remote</span><span class="method-args">(remote_name = 'origin')</span> </a> </div> <div class="method-description"> + <p> +returns a <a href="Remote.html">Git::Remote</a> object +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000096-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000096-source"> + onclick="toggleCode('M000099-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000099-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 144</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 172</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">remote</span>(<span class="ruby-identifier">remote_name</span> = <span class="ruby-value str">'origin'</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-keyword kw">self</span>, <span class="ruby-identifier">remote_name</span>) <span class="ruby-keyword kw">end</span> @@ -928,21 +1058,25 @@ factory methods </div> </div> - <div id="method-M000111" class="method-detail"> - <a name="M000111"></a> + <div id="method-M000114" class="method-detail"> + <a name="M000114"></a> <div class="method-heading"> - <a href="#M000111" class="method-signature"> + <a href="#M000114" class="method-signature"> <span class="method-name">remotes</span><span class="method-args">()</span> </a> </div> <div class="method-description"> + <p> +returns an array of <a href="../Git.html">Git</a>:<a +href="Remote.html">Remote</a> objects +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000111-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000111-source"> + onclick="toggleCode('M000114-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000114-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 209</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 279</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">remotes</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">remotes</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">r</span><span class="ruby-operator">|</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-keyword kw">self</span>, <span class="ruby-identifier">r</span>) } <span class="ruby-keyword kw">end</span> @@ -951,21 +1085,24 @@ factory methods </div> </div> - <div id="method-M000101" class="method-detail"> - <a name="M000101"></a> + <div id="method-M000104" class="method-detail"> + <a name="M000104"></a> <div class="method-heading"> - <a href="#M000101" class="method-signature"> + <a href="#M000104" class="method-signature"> <span class="method-name">remove</span><span class="method-args">(path = '.', opts = {})</span> </a> </div> <div class="method-description"> + <p> +removes file(s) from the git repository +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000101-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000101-source"> + onclick="toggleCode('M000104-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000104-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 166</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 217</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">remove</span>(<span class="ruby-identifier">path</span> = <span class="ruby-value str">'.'</span>, <span class="ruby-identifier">opts</span> = {}) <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">remove</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">opts</span>) <span class="ruby-keyword kw">end</span> @@ -974,24 +1111,24 @@ factory methods </div> </div> - <div id="method-M000116" class="method-detail"> - <a name="M000116"></a> + <div id="method-M000119" class="method-detail"> + <a name="M000119"></a> <div class="method-heading"> - <a href="#M000116" class="method-signature"> + <a href="#M000119" class="method-signature"> <span class="method-name">repack</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> -convenience methods +repacks the repository </p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000116-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000116-source"> + onclick="toggleCode('M000119-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000119-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 236</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 315</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">repack</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">repack</span> <span class="ruby-keyword kw">end</span> @@ -1000,21 +1137,27 @@ convenience methods </div> </div> - <div id="method-M000083" class="method-detail"> - <a name="M000083"></a> + <div id="method-M000086" class="method-detail"> + <a name="M000086"></a> <div class="method-heading"> - <a href="#M000083" class="method-signature"> + <a href="#M000086" class="method-signature"> <span class="method-name">repo</span><span class="method-args">()</span> </a> </div> <div class="method-description"> + <p> +returns reference to the git repository directory +</p> +<pre> + @git.dir.path +</pre> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000083-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000083-source"> + onclick="toggleCode('M000086-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000086-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 79</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 84</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">repo</span> <span class="ruby-ivar">@repository</span> <span class="ruby-keyword kw">end</span> @@ -1023,21 +1166,24 @@ convenience methods </div> </div> - <div id="method-M000086" class="method-detail"> - <a name="M000086"></a> + <div id="method-M000089" class="method-detail"> + <a name="M000089"></a> <div class="method-heading"> - <a href="#M000086" class="method-signature"> + <a href="#M000089" class="method-signature"> <span class="method-name">repo_size</span><span class="method-args">()</span> </a> </div> <div class="method-description"> + <p> +returns the repository size in bytes +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000086-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000086-source"> + onclick="toggleCode('M000089-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000089-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 93</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 109</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">repo_size</span> <span class="ruby-identifier">size</span> = <span class="ruby-value">0</span> <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span>(<span class="ruby-identifier">repo</span>.<span class="ruby-identifier">path</span>) <span class="ruby-keyword kw">do</span> @@ -1050,21 +1196,24 @@ convenience methods </div> </div> - <div id="method-M000102" class="method-detail"> - <a name="M000102"></a> + <div id="method-M000105" class="method-detail"> + <a name="M000105"></a> <div class="method-heading"> - <a href="#M000102" class="method-signature"> + <a href="#M000105" class="method-signature"> <span class="method-name">reset</span><span class="method-args">(commitish = nil, opts = {})</span> </a> </div> <div class="method-description"> + <p> +resets the working directory to the provided commitish +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000102-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000102-source"> + onclick="toggleCode('M000105-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000105-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 170</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 222</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset</span>(<span class="ruby-identifier">commitish</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">opts</span> = {}) <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">reset</span>(<span class="ruby-identifier">commitish</span>, <span class="ruby-identifier">opts</span>) <span class="ruby-keyword kw">end</span> @@ -1073,21 +1222,25 @@ convenience methods </div> </div> - <div id="method-M000103" class="method-detail"> - <a name="M000103"></a> + <div id="method-M000106" class="method-detail"> + <a name="M000106"></a> <div class="method-heading"> - <a href="#M000103" class="method-signature"> + <a href="#M000106" class="method-signature"> <span class="method-name">reset_hard</span><span class="method-args">(commitish = nil, opts = {})</span> </a> </div> <div class="method-description"> + <p> +resets the working directory to the commitish with +’—hard’ +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000103-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000103-source"> + onclick="toggleCode('M000106-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000106-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 174</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 227</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset_hard</span>(<span class="ruby-identifier">commitish</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">opts</span> = {}) <span class="ruby-identifier">opts</span> = {<span class="ruby-identifier">:hard</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">opts</span>) <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">reset</span>(<span class="ruby-identifier">commitish</span>, <span class="ruby-identifier">opts</span>) @@ -1097,21 +1250,29 @@ convenience methods </div> </div> - <div id="method-M000117" class="method-detail"> - <a name="M000117"></a> + <div id="method-M000120" class="method-detail"> + <a name="M000120"></a> <div class="method-heading"> - <a href="#M000117" class="method-signature"> + <a href="#M000120" class="method-signature"> <span class="method-name">revparse</span><span class="method-args">(objectish)</span> </a> </div> <div class="method-description"> + <p> +runs git rev-parse to convert the objectish to a full sha +</p> +<pre> + @git.revparse("HEAD^^") + @git.revparse('v2.4^{tree}') + @git.revparse('v2.4:/doc/index.html') +</pre> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000117-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000117-source"> + onclick="toggleCode('M000120-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000120-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 240</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 325</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">revparse</span>(<span class="ruby-identifier">objectish</span>) <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">revparse</span>(<span class="ruby-identifier">objectish</span>) <span class="ruby-keyword kw">end</span> @@ -1120,21 +1281,24 @@ convenience methods </div> </div> - <div id="method-M000093" class="method-detail"> - <a name="M000093"></a> + <div id="method-M000096" class="method-detail"> + <a name="M000096"></a> <div class="method-heading"> - <a href="#M000093" class="method-signature"> + <a href="#M000096" class="method-signature"> <span class="method-name">status</span><span class="method-args">()</span> </a> </div> <div class="method-description"> + <p> +returns a <a href="Status.html">Git::Status</a> object +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000093-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000093-source"> + onclick="toggleCode('M000096-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000096-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 132</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 157</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">status</span> <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Status</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>) <span class="ruby-keyword kw">end</span> @@ -1143,21 +1307,24 @@ convenience methods </div> </div> - <div id="method-M000114" class="method-detail"> - <a name="M000114"></a> + <div id="method-M000117" class="method-detail"> + <a name="M000117"></a> <div class="method-heading"> - <a href="#M000114" class="method-signature"> + <a href="#M000117" class="method-signature"> <span class="method-name">tag</span><span class="method-args">(tag_name)</span> </a> </div> <div class="method-description"> + <p> +returns a Git::Tag object +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000114-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000114-source"> + onclick="toggleCode('M000117-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000117-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 225</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 304</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">tag</span>(<span class="ruby-identifier">tag_name</span>) <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Object</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">tag_name</span>, <span class="ruby-keyword kw">true</span>) <span class="ruby-keyword kw">end</span> @@ -1166,21 +1333,24 @@ convenience methods </div> </div> - <div id="method-M000113" class="method-detail"> - <a name="M000113"></a> + <div id="method-M000116" class="method-detail"> + <a name="M000116"></a> <div class="method-heading"> - <a href="#M000113" class="method-signature"> + <a href="#M000116" class="method-signature"> <span class="method-name">tags</span><span class="method-args">()</span> </a> </div> <div class="method-description"> + <p> +returns an array of all Git::Tag objects for this repository +</p> <p><a class="source-toggle" href="#" - onclick="toggleCode('M000113-source');return false;">[Source]</a></p> - <div class="method-source-code" id="M000113-source"> + onclick="toggleCode('M000116-source');return false;">[Source]</a></p> + <div class="method-source-code" id="M000116-source"> <pre> -<span class="ruby-comment cmt"># File lib/git/base.rb, line 221</span> +<span class="ruby-comment cmt"># File lib/git/base.rb, line 299</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">tags</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">tags</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">r</span><span class="ruby-operator">|</span> <span class="ruby-identifier">tag</span>(<span class="ruby-identifier">r</span>) } <span class="ruby-keyword kw">end</span> |