doc/index.html in ruby-prof-0.15.6 vs doc/index.html in ruby-prof-0.15.7
- old
+ new
@@ -160,11 +160,14 @@
<p>Threads - supports profiling multiple threads simultaneously</p>
</li></ul>
<h2 id="label-Requirements">Requirements<span><a href="#label-Requirements">¶</a> <a href="#top">↑</a></span></h2>
-<p>ruby-prof requires Ruby 1.9.3 or higher.</p>
+<p>ruby-prof requires Ruby 1.9.3 or higher. Please note some ruby releases
+have known bugs which cause ruby-prof problems, like incorrect
+measurements. We suggest to use the latest minor patch level release if
+possible. In particular, on the 2.1 branch of ruby you should use 2.1.5.</p>
<p>If you are running Linux or Unix you'll need a C compiler so the
extension can be compiled when it is installed.</p>
<p>If you are running Windows, then you may need to install the Windows
@@ -294,22 +297,19 @@
<p>If you want to get a more accurate measurement of what takes all of a
gem's bin/xxx command to load, you may want to also measure
rubygems' startup penalty. You can do this by calling into
bin/ruby-prof directly, ex:</p>
-<p>$ gem which ruby-prof</p>
+<pre>$ gem which ruby-prof
+g:/192/lib/ruby/gems/1.9.1/gems/ruby-prof-0.10.2/lib/ruby-prof.rb</pre>
-<pre>g:/192/lib/ruby/gems/1.9.1/gems/ruby-prof-0.10.2/lib/ruby-prof.rb</pre>
-
<p>now run it thus (substitute lib/ruby-prof.rb with bin/ruby-prof):</p>
-<p>$ ruby g:/192/lib/ruby/gems/1.9.1/gems/ruby-prof-0.10.2/bin/ruby-prof
-g:192binsome_installed_gem_command</p>
+<pre>$ ruby g:/192/lib/ruby/gems/1.9.1/gems/ruby-prof-0.10.2/bin/ruby-prof g:\192\bin\some_installed_gem_command</pre>
<p>or</p>
-<p>$ ruby g:/192/lib/ruby/gems/1.9.1/gems/ruby-prof-0.10.2/bin/ruby-prof
-./some_file_that_does_a_require_rubygems_at_the_beginning.rb</p>
+<pre>$ ruby g:/192/lib/ruby/gems/1.9.1/gems/ruby-prof-0.10.2/bin/ruby-prof ./some_file_that_does_a_require_rubygems_at_the_beginning.rb</pre>
<h2 id="label-Profiling+Rails">Profiling Rails<span><a href="#label-Profiling+Rails">¶</a> <a href="#top">↑</a></span></h2>
<p>To profile a Rails application it is vital to run it using production like
settings (cache classes, cache view lookups, etc.). Otherwise, Rail's