Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 24 additions & 21 deletions CONTRIBUTING_rdoc.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,14 @@ <h2>
<div class="nav-section">
<h3>Table of Contents</h3>



<ul class="link-list" role="directory">
<li><a href="#label-Source+Repository">Source Repository</a>
<li><a href="#label-Running+the+Rake+Test+Suite">Running the Rake Test Suite</a>
<li><a href="#label-Rubocop">Rubocop</a>
<li><a href="#label-Issues+and+Bug+Reports">Issues and Bug Reports</a>
<li> <a href="#label-Source+Repository">Source Repository</a>
<li> <a href="#label-Running+the+Rake+Test+Suite">Running the Rake Test Suite</a>
<li> <a href="#label-RuboCop">RuboCop</a>
<li> <a href="#label-Issues+and+Bug+Reports">Issues and Bug Reports</a>

</ul>
</div>

Expand All @@ -76,11 +79,14 @@ <h3>Pages</h3>
<li><a href="./History_rdoc.html">History</a>
<li><a href="./MIT-LICENSE.html">MIT-LICENSE</a>
<li><a href="./README_rdoc.html">README</a>
<li><a href="./doc/command_line_usage_rdoc.html">command_line_usage</a>
<li><a href="./doc/glossary_rdoc.html">glossary</a>
<li><a href="./doc/proto_rake_rdoc.html">proto_rake</a>
<li><a href="./doc/rakefile_rdoc.html">rakefile</a>
<li><a href="./doc/rational_rdoc.html">rational</a>
<li><details><summary>doc</summary>
<ul class="link-list">
<li><a href="./doc/command_line_usage_rdoc.html">command_line_usage</a>
<li><a href="./doc/glossary_rdoc.html">glossary</a>
<li><a href="./doc/proto_rake_rdoc.html">proto_rake</a>
<li><a href="./doc/rakefile_rdoc.html">rakefile</a>
<li><a href="./doc/rational_rdoc.html">rational</a>
</ul></details>
</ul>
</div>

Expand All @@ -91,7 +97,7 @@ <h3>Pages</h3>

<h1 id="label-Source+Repository">Source Repository<span><a href="#label-Source+Repository">&para;</a> <a href="#top">&uarr;</a></span></h1>

<p>Rake is currently hosted at github. The github web page is <a href="https://github.com/ruby/rake">github.com/ruby/rake</a> . The public git clone URL is</p>
<p>Rake is hosted at GitHub. The GitHub Web page is <a href="https://github.com/ruby/rake">github.com/ruby/rake</a> . The public Git clone URL is</p>

<pre class="ruby"><span class="ruby-identifier">https</span><span class="ruby-value">:/</span><span class="ruby-operator">/</span><span class="ruby-identifier">github</span>.<span class="ruby-identifier">com</span><span class="ruby-operator">/</span><span class="ruby-identifier">ruby</span><span class="ruby-operator">/</span><span class="ruby-identifier">rake</span>.<span class="ruby-identifier">git</span>
</pre>
Expand All @@ -104,39 +110,36 @@ <h1 id="label-Running+the+Rake+Test+Suite">Running the Rake Test Suite<span><a h
</li><li>
<p>Install gem dependency using bundler:</p>

<pre>$ bundle install # Install bundler, minitest and rdoc</pre>
<pre>$ bin/setup # Install development dependencies</pre>
</li><li>
<p>Run the test suite</p>

<pre>$ rake</pre>
</li></ul>

<h1 id="label-Rubocop">Rubocop<span><a href="#label-Rubocop">&para;</a> <a href="#top">&uarr;</a></span></h1>
<h1 id="label-RuboCop">RuboCop<span><a href="#label-RuboCop">&para;</a> <a href="#top">&uarr;</a></span></h1>

<p>Rake uses Rubocop to enforce a consistent style on new changes being proposed. You can check your code with Rubocop using:</p>
<p>Rake uses RuboCop to enforce a consistent style on new changes being proposed. You can check your code with RuboCop using:</p>

<pre>$ ./bin/rubocop</pre>
<pre>$ bin/rubocop</pre>

<h1 id="label-Issues+and+Bug+Reports">Issues and Bug Reports<span><a href="#label-Issues+and+Bug+Reports">&para;</a> <a href="#top">&uarr;</a></span></h1>

<p>Feel free to submit commits or feature requests. If you send a patch, remember to update the corresponding unit tests. In fact, I prefer new feature to be submitted in the form of new unit tests.</p>
<p>Feel free to submit commits or feature requests. If you send a patch, remember to update the corresponding unit tests. In fact, the team prefers a new feature to be submitted in the form of new unit tests.</p>

<p>For other information, feel free to ask on the ruby-talk mailing list.</p>

<p>If you have found a bug in rake please try with the latest version of rake before filing an issue. Also check <a href="History_rdoc.html">History.rdoc</a> for bug fixes that may have addressed your issue.</p>
<p>If you have found a bug in rake, please try with the latest version of rake before filing an issue. Also check <a href="History_rdoc.html">History.rdoc</a> for bug fixes that may have addressed your issue.</p>

<p>When submitting pull requests please check the rake Travis-CI page for test failures:</p>

<pre class="ruby"><span class="ruby-identifier">https</span><span class="ruby-value">:/</span><span class="ruby-operator">/</span><span class="ruby-identifier">travis</span><span class="ruby-operator">-</span><span class="ruby-identifier">ci</span>.<span class="ruby-identifier">org</span><span class="ruby-operator">/</span><span class="ruby-identifier">ruby</span><span class="ruby-operator">/</span><span class="ruby-identifier">rake</span>
</pre>
<p>When submitting pull requests, please check the status checks on your PR page to confirm if it says “All checks have passed”.</p>

</main>



<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.1.
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.5.0.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

48 changes: 28 additions & 20 deletions FileUtils.html
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,12 @@ <h3>Public Instance Methods</h3>
</header>

<div id="method-i-ruby" class="method-detail ">
<div class="method-heading">
<span class="method-name">ruby</span><span
class="method-args">(*args, **options, &amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
<div class="method-header">
<div class="method-heading">
<span class="method-name">ruby</span><span
class="method-args">(*args, **options, &amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
</div>

<div class="method-description">
Expand All @@ -123,7 +125,7 @@ <h3>Public Instance Methods</h3>
</pre>

<div class="method-source-code" id="ruby-source">
<pre><span class="ruby-comment"># File lib/rake/file_utils.rb, line 100</span>
<pre><span class="ruby-comment"># File lib/rake/file_utils.rb, line 98</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ruby</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">**</span><span class="ruby-identifier">options</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">1</span>
<span class="ruby-identifier">sh</span>(<span class="ruby-constant">RUBY</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">**</span><span class="ruby-identifier">options</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
Expand All @@ -138,17 +140,19 @@ <h3>Public Instance Methods</h3>
</div>

<div id="method-i-safe_ln" class="method-detail ">
<div class="method-heading">
<span class="method-name">safe_ln</span><span
class="method-args">(*args, **options)</span>
<span class="method-click-advice">click to toggle source</span>
<div class="method-header">
<div class="method-heading">
<span class="method-name">safe_ln</span><span
class="method-args">(*args, **options)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
</div>

<div class="method-description">
<p>Attempt to do a normal file link, but fall back to a copy if the link fails.</p>

<div class="method-source-code" id="safe_ln-source">
<pre><span class="ruby-comment"># File lib/rake/file_utils.rb, line 112</span>
<pre><span class="ruby-comment"># File lib/rake/file_utils.rb, line 110</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">safe_ln</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">**</span><span class="ruby-identifier">options</span>)
<span class="ruby-keyword">if</span> <span class="ruby-constant">LN_SUPPORTED</span>[<span class="ruby-value">0</span>]
<span class="ruby-keyword">begin</span>
Expand All @@ -166,10 +170,12 @@ <h3>Public Instance Methods</h3>
</div>

<div id="method-i-sh" class="method-detail ">
<div class="method-heading">
<span class="method-name">sh</span><span
class="method-args">(*cmd, &amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
<div class="method-header">
<div class="method-heading">
<span class="method-name">sh</span><span
class="method-args">(*cmd, &amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
</div>

<div class="method-description">
Expand Down Expand Up @@ -219,10 +225,12 @@ <h3>Public Instance Methods</h3>
</div>

<div id="method-i-split_all" class="method-detail ">
<div class="method-heading">
<span class="method-name">split_all</span><span
class="method-args">(path)</span>
<span class="method-click-advice">click to toggle source</span>
<div class="method-header">
<div class="method-heading">
<span class="method-name">split_all</span><span
class="method-args">(path)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
</div>

<div class="method-description">
Expand All @@ -234,7 +242,7 @@ <h3>Public Instance Methods</h3>
</pre>

<div class="method-source-code" id="split_all-source">
<pre><span class="ruby-comment"># File lib/rake/file_utils.rb, line 128</span>
<pre><span class="ruby-comment"># File lib/rake/file_utils.rb, line 126</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">split_all</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-identifier">head</span>, <span class="ruby-identifier">tail</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">split</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-keyword">return</span> [<span class="ruby-identifier">tail</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">head</span> <span class="ruby-operator">==</span> <span class="ruby-string">&quot;.&quot;</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">tail</span> <span class="ruby-operator">==</span> <span class="ruby-string">&quot;/&quot;</span>
Expand All @@ -255,7 +263,7 @@ <h3>Public Instance Methods</h3>

<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.1.
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.5.0.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

Loading