doc/index.html in ruby-prof-0.15.2 vs doc/index.html in ruby-prof-0.15.3
- old
+ new
@@ -4,25 +4,22 @@
<head>
<meta charset="UTF-8">
<title>ruby-prof</title>
-<link href="./fonts.css" rel="stylesheet">
-<link href="./rdoc.css" rel="stylesheet">
-
<script type="text/javascript">
var rdoc_rel_prefix = "./";
</script>
<script src="./js/jquery.js"></script>
-<script src="./js/navigation.js"></script>
-<script src="./js/search_index.js"></script>
-<script src="./js/search.js"></script>
-<script src="./js/searcher.js"></script>
<script src="./js/darkfish.js"></script>
+<link href="./css/fonts.css" rel="stylesheet">
+<link href="./css/rdoc.css" rel="stylesheet">
+
+
<body id="top" role="document" class="file">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
@@ -76,10 +73,12 @@
<div id="classindex-section" class="nav-section">
<h3>Class and Module Index</h3>
<ul class="link-list">
+ <li><a href="./Rack.html">Rack</a>
+
<li><a href="./Rack/RubyProf.html">Rack::RubyProf</a>
<li><a href="./RubyProf.html">RubyProf</a>
<li><a href="./RubyProf/AbstractPrinter.html">RubyProf::AbstractPrinter</a>
@@ -125,17 +124,17 @@
</nav>
<main role="main">
-<h1 id="label-ruby-prof">ruby-prof<span><a href="#label-ruby-prof">¶</a> <a href="#documentation">↑</a></span></h1>
+<h1 id="label-ruby-prof">ruby-prof<span><a href="#label-ruby-prof">¶</a> <a href="#top">↑</a></span></h1>
<p><a href="https://travis-ci.org/ruby-prof/ruby-prof"><img
src="https://travis-ci.org/ruby-prof/ruby-prof.png?branch=master"
alt="Build Status" /></a></p>
-<h2 id="label-Overview">Overview<span><a href="#label-Overview">¶</a> <a href="#documentation">↑</a></span></h2>
+<h2 id="label-Overview">Overview<span><a href="#label-Overview">¶</a> <a href="#top">↑</a></span></h2>
<p>ruby-prof is a fast code profiler for Ruby. Its features include:</p>
<ul><li>
<p>Speed - it is a C extension and therefore many times faster than the
standard Ruby profiler.</p>
@@ -159,123 +158,121 @@
</li></ul>
</li><li>
<p>Threads - supports profiling multiple threads simultaneously</p>
</li></ul>
-<h2 id="label-Requirements">Requirements<span><a href="#label-Requirements">¶</a> <a href="#documentation">↑</a></span></h2>
+<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>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 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
specific RubyGem which includes an already built extension (see Install
section).</p>
-<h2 id="label-Install">Install<span><a href="#label-Install">¶</a> <a href="#documentation">↑</a></span></h2>
+<h2 id="label-Install">Install<span><a href="#label-Install">¶</a> <a href="#top">↑</a></span></h2>
<p>The easiest way to install ruby-prof is by using Ruby Gems. To install:</p>
-<pre>gem install ruby-prof</pre>
+<pre class="ruby"><span class="ruby-identifier">gem</span> <span class="ruby-identifier">install</span> <span class="ruby-identifier">ruby</span><span class="ruby-operator">-</span><span class="ruby-identifier">prof</span>
+</pre>
-<p>If you’re on windows then please install the devkit first so that it can
-compile.</p>
+<p>If you're on windows then please install the devkit first so that it
+can compile.</p>
-<h2 id="label-Usage">Usage<span><a href="#label-Usage">¶</a> <a href="#documentation">↑</a></span></h2>
+<h2 id="label-Usage">Usage<span><a href="#label-Usage">¶</a> <a href="#top">↑</a></span></h2>
<p>There are two ways of running ruby-prof, via the command line or via its
API.</p>
-<h3 id="label-ruby-prof+executable">ruby-prof executable<span><a href="#label-ruby-prof+executable">¶</a> <a href="#documentation">↑</a></span></h3>
+<h3 id="label-ruby-prof+executable">ruby-prof executable<span><a href="#label-ruby-prof+executable">¶</a> <a href="#top">↑</a></span></h3>
<p>The first is to use ruby-prof to run the Ruby program you want to profile.
For more information refer to the documentation of the ruby-prof command.</p>
-<h3 id="label-ruby-prof+API">ruby-prof API<span><a href="#label-ruby-prof+API">¶</a> <a href="#documentation">↑</a></span></h3>
+<h3 id="label-ruby-prof+API">ruby-prof API<span><a href="#label-ruby-prof+API">¶</a> <a href="#top">↑</a></span></h3>
<p>The second way is to use the ruby-prof API to profile particular segments
of code.</p>
-<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'ruby-prof'</span>
+<pre>require 'ruby-prof'
-<span class="ruby-comment"># Profile the code</span>
-<span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">start</span>
-<span class="ruby-operator">...</span>
-[<span class="ruby-identifier">code</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">profile</span>]
-<span class="ruby-operator">...</span>
-<span class="ruby-identifier">result</span> = <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">stop</span>
+# Profile the code
+RubyProf.start
+...
+[code to profile]
+...
+result = RubyProf.stop
-<span class="ruby-comment"># Print a flat profile to text</span>
-<span class="ruby-identifier">printer</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">FlatPrinter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">result</span>)
-<span class="ruby-identifier">printer</span>.<span class="ruby-identifier">print</span>(<span class="ruby-constant">STDOUT</span>)
-</pre>
+# Print a flat profile to text
+printer = RubyProf::FlatPrinter.new(result)
+printer.print(STDOUT)</pre>
<p>Alternatively, you can use a block to tell ruby-prof what to profile:</p>
-<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'ruby-prof'</span>
+<pre>require 'ruby-prof'
-<span class="ruby-comment"># Profile the code</span>
-<span class="ruby-identifier">result</span> = <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">profile</span> <span class="ruby-keyword">do</span>
- <span class="ruby-operator">...</span>
- [<span class="ruby-identifier">code</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">profile</span>]
- <span class="ruby-operator">...</span>
-<span class="ruby-keyword">end</span>
+# Profile the code
+result = RubyProf.profile do
+ ...
+ [code to profile]
+ ...
+end
-<span class="ruby-comment"># Print a graph profile to text</span>
-<span class="ruby-identifier">printer</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">GraphPrinter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">result</span>)
-<span class="ruby-identifier">printer</span>.<span class="ruby-identifier">print</span>(<span class="ruby-constant">STDOUT</span>, {})
-</pre>
+# Print a graph profile to text
+printer = RubyProf::GraphPrinter.new(result)
+printer.print(STDOUT, {})</pre>
<p>ruby-prof also supports pausing and resuming profiling runs.</p>
-<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'ruby-prof'</span>
+<pre>require 'ruby-prof'
-<span class="ruby-comment"># Profile the code</span>
-<span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">start</span>
-[<span class="ruby-identifier">code</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">profile</span>]
-<span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">pause</span>
-[<span class="ruby-identifier">other</span> <span class="ruby-identifier">code</span>]
-<span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">resume</span>
-[<span class="ruby-identifier">code</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">profile</span>]
-<span class="ruby-identifier">result</span> = <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">stop</span>
-</pre>
+# Profile the code
+RubyProf.start
+[code to profile]
+RubyProf.pause
+[other code]
+RubyProf.resume
+[code to profile]
+result = RubyProf.stop</pre>
<p>Note that resume will automatically call start if a profiling run has not
yet started. In addition, resume can also take a block:</p>
-<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'ruby-prof'</span>
+<pre>require 'ruby-prof'
-<span class="ruby-comment"># Profile the code</span>
-<span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">resume</span> <span class="ruby-keyword">do</span>
- [<span class="ruby-identifier">code</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">profile</span>]
-<span class="ruby-keyword">end</span>
+# Profile the code
+RubyProf.resume do
+ [code to profile]
+end
-<span class="ruby-identifier">data</span> = <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">stop</span>
-</pre>
+data = RubyProf.stop</pre>
<p>With this usage, resume will automatically call pause at the end of the
block.</p>
-<h2 id="label-Method+and+Thread+Elimination">Method and Thread Elimination<span><a href="#label-Method+and+Thread+Elimination">¶</a> <a href="#documentation">↑</a></span></h2>
+<h2 id="label-Method+and+Thread+Elimination">Method and Thread Elimination<span><a href="#label-Method+and+Thread+Elimination">¶</a> <a href="#top">↑</a></span></h2>
<p>ruby-prof supports eliminating specific methods and threads from profiling
results. This is useful for reducing connectivity in the call graph, making
it easier to identify the source of performance problems when using a graph
printer.</p>
-<p>For example, consider Integer#times: it’s hardly ever useful to know how
-much time is spent in the method itself. We’re much more interested in how
-much the passed in block contributes to the time spent in the method which
-contains the Integer#times call.</p>
+<p>For example, consider Integer#times: it's hardly ever useful to know
+how much time is spent in the method itself. We're much more interested
+in how much the passed in block contributes to the time spent in the method
+which contains the Integer#times call.</p>
<p>Methods are eliminated from the collected data by calling
`eliminate_methods!` on the profiling result, before submitting it to a
printer.</p>
-<pre>result = RubyProf.stop
-result.eliminate_methods!([/Integer#times/])</pre>
+<pre class="ruby"><span class="ruby-identifier">result</span> = <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">stop</span>
+<span class="ruby-identifier">result</span>.<span class="ruby-identifier">eliminate_methods!</span>([<span class="ruby-node">/Integer#times/</span>])
+</pre>
<p>The argument given to `eliminate_methods!` is either an array of regular
expressions, or the name of a file containing a list of regular expressions
(line separated text).</p>
@@ -283,21 +280,23 @@
those methods had been inlined at their call sites.</p>
<p>In a similar manner, threads can be excluded so they are not profiled at
all. To do this, pass an array of threads to exclude to ruby-prof:</p>
-<pre>RubyProf::exclude_threads = [ thread2 ]
-RubyProf.start</pre>
+<pre class="ruby"><span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-identifier">exclude_threads</span> = [ <span class="ruby-identifier">thread2</span> ]
+<span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">start</span>
+</pre>
<p>Note that the excluded threads must be specified <strong>before</strong>
profiling.</p>
-<h2 id="label-Benchmarking+full+load+time+including+rubygems+startup+cost">Benchmarking full load time including rubygems startup cost<span><a href="#label-Benchmarking+full+load+time+including+rubygems+startup+cost">¶</a> <a href="#documentation">↑</a></span></h2>
+<h2 id="label-Benchmarking+full+load+time+including+rubygems+startup+cost">Benchmarking full load time including rubygems startup cost<span><a href="#label-Benchmarking+full+load+time+including+rubygems+startup+cost">¶</a> <a href="#top">↑</a></span></h2>
-<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>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>g:/192/lib/ruby/gems/1.9.1/gems/ruby-prof-0.10.2/lib/ruby-prof.rb</pre>
@@ -309,14 +308,14 @@
<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>
-<h2 id="label-Profiling+Rails">Profiling Rails<span><a href="#label-Profiling+Rails">¶</a> <a href="#documentation">↑</a></span></h2>
+<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
+settings (cache classes, cache view lookups, etc.). Otherwise, Rail's
dependency loading code will overwhelm any time spent in the application
itself (our tests show that Rails dependency loading causes a roughly 6x
slowdown). The best way to do this is create a new Rails environment,
profile.rb.</p>
@@ -327,19 +326,20 @@
overwhelemed by the time Rails spends loading required files. You should
likely turn off caching.</p>
</li><li>
<p>Add the ruby-prof to your gemfile:</p>
-<pre>group :profile do
- gem 'ruby-prof'
-end</pre>
+<pre class="ruby"><span class="ruby-identifier">group</span> :<span class="ruby-identifier">profile</span> <span class="ruby-keyword">do</span>
+ <span class="ruby-identifier">gem</span> <span class="ruby-string">'ruby-prof'</span>
+<span class="ruby-keyword">end</span>
+</pre>
</li><li>
<p>Add the ruby prof rack adapter to your middleware stack. One way to do
this is by adding the following code to config.ru:</p>
<pre class="ruby"><span class="ruby-keyword">if</span> <span class="ruby-constant">Rails</span>.<span class="ruby-identifier">env</span>.<span class="ruby-identifier">profile?</span>
- <span class="ruby-identifier">use</span> <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">RubyProf</span>, :<span class="ruby-identifier">path</span> =<span class="ruby-operator">></span> <span class="ruby-string">'/temp/profile'</span>
+ <span class="ruby-identifier">use</span> <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">RubyProf</span>, :<span class="ruby-identifier">path</span> =<span class="ruby-operator">></span> <span class="ruby-string">'/temp/profile'</span>
<span class="ruby-keyword">end</span>
</pre>
<p>The path is where you want profiling results to be stored. By default the
rack adapter will generate a html call graph report and flat text report.</p>
@@ -347,11 +347,11 @@
<p>Now make a request to your running server. New profiling information will
be generated for each request. Note that each request will overwrite the
profiling reports created by the previous request!</p>
</li></ol>
-<h2 id="label-Reports">Reports<span><a href="#label-Reports">¶</a> <a href="#documentation">↑</a></span></h2>
+<h2 id="label-Reports">Reports<span><a href="#label-Reports">¶</a> <a href="#top">↑</a></span></h2>
<p>ruby-prof can generate a number of different reports:</p>
<ul><li>
<p>Flat Reports</p>
</li><li>
@@ -397,17 +397,17 @@
href="http://github.com/ruby-prof/ruby-prof/tree/master/examples/call_stack.html">examples/stack.html</a>.</p>
<p>Another good example: [<a
href="http://twitpic.com/28z94a">twitpic.com/28z94a</a>]</p>
-<p>Finally, there’s a so called MultiPrinter which can generate several
+<p>Finally, there's a so called MultiPrinter which can generate several
reports in one profiling run. See <a
href="http://github.com/ruby-prof/ruby-prof/tree/master/examples/multi.stack.html">examples/multi.stack.html</a>.</p>
<p>There is also a graphviz .dot visualiser.</p>
-<h2 id="label-Printers">Printers<span><a href="#label-Printers">¶</a> <a href="#documentation">↑</a></span></h2>
+<h2 id="label-Printers">Printers<span><a href="#label-Printers">¶</a> <a href="#top">↑</a></span></h2>
<p>Reports are created by printers. Supported printers include:</p>
<ul><li>
<p><a href="RubyProf/FlatPrinter.html">RubyProf::FlatPrinter</a> - Creates a
flat report in text format</p>
@@ -421,11 +421,11 @@
</li><li>
<p><a href="RubyProf/GraphHtmlPrinter.html">RubyProf::GraphHtmlPrinter</a> -
Creates a call graph report in HTML (separate files per thread)</p>
</li><li>
<p><a href="RubyProf/DotPrinter.html">RubyProf::DotPrinter</a> - Creates a
-call graph report in GraphViz's DOT format which can be converted to an
+call graph report in GraphViz's DOT format which can be converted to an
image</p>
</li><li>
<p><a href="RubyProf/CallTreePrinter.html">RubyProf::CallTreePrinter</a> -
Creates a call tree report compatible with KCachegrind.</p>
</li><li>
@@ -438,15 +438,14 @@
<p>More!</p>
</li></ul>
<p>To use a printer:</p>
-<pre class="ruby"><span class="ruby-operator">...</span>
-<span class="ruby-identifier">result</span> = <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">stop</span>
-<span class="ruby-identifier">printer</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">GraphPrinter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">result</span>)
-<span class="ruby-identifier">printer</span>.<span class="ruby-identifier">print</span>(<span class="ruby-constant">STDOUT</span>, :<span class="ruby-identifier">min_percent</span> =<span class="ruby-operator">></span> <span class="ruby-value">2</span>)
-</pre>
+<pre>...
+result = RubyProf.stop
+printer = RubyProf::GraphPrinter.new(result)
+printer.print(STDOUT, :min_percent => 2)</pre>
<p>The first parameter is any writable IO object such as STDOUT or a file. The
second parameter, specifies the minimum percentage a method must take to be
printed. Percentages should be specified as integers in the range 0 to
100. For more information please see the documentation for the different
@@ -460,11 +459,11 @@
<pre class="ruby"><span class="ruby-identifier">printer</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">MultiPrinter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">result</span>)
<span class="ruby-identifier">printer</span>.<span class="ruby-identifier">print</span>(:<span class="ruby-identifier">path</span> =<span class="ruby-operator">></span> <span class="ruby-string">"."</span>, :<span class="ruby-identifier">profile</span> =<span class="ruby-operator">></span> <span class="ruby-string">"profile"</span>)
</pre>
-<h2 id="label-Measurements">Measurements<span><a href="#label-Measurements">¶</a> <a href="#documentation">↑</a></span></h2>
+<h2 id="label-Measurements">Measurements<span><a href="#label-Measurements">¶</a> <a href="#top">↑</a></span></h2>
<p>Depending on the mode and platform, ruby-prof can measure various aspects
of a Ruby program. Supported measurements include:</p>
<ul><li>
<p>process time (RubyProf::PROCESS_TIME)</p>
@@ -491,28 +490,28 @@
there are other processes concurrently running on the system that use
significant CPU or disk time during a profiling run then the reported
results will be too large.</p>
<p>CPU time uses the CPU clock counter to measure time. The returned values
-are dependent on the correctly setting the CPU’s frequency. This mode is
-only supported on Pentium or PowerPC platforms (linux only).</p>
+are dependent on the correctly setting the CPU's frequency. This mode
+is only supported on Pentium or PowerPC platforms (linux only).</p>
<p>Object allocation reports show how many objects each method in a program
allocates. This support was added by Sylvain Joyeux and requires a patched
Ruby interpreter. See below.</p>
<p>Memory usage reports show how much memory each method in a program uses.
This support was added by Alexander Dymo and requires a patched Ruby
interpreter. See below.</p>
-<p>Garbage collection runs report how many times Ruby’s garbage collector is
-invoked during a profiling session. This support was added by Jeremy
+<p>Garbage collection runs report how many times Ruby's garbage collector
+is invoked during a profiling session. This support was added by Jeremy
Kemper and requires a patched Ruby interpreter. See below.</p>
-<p>Garbage collection time reports how much time is spent in Ruby’s garbage
-collector during a profiling session. This support was added by Jeremy
-Kemper and requires a patched Ruby interpreter. See below.</p>
+<p>Garbage collection time reports how much time is spent in Ruby's
+garbage collector during a profiling session. This support was added by
+Jeremy Kemper and requires a patched Ruby interpreter. See below.</p>
<p>Ruby patches: all of the patches to Ruby are included in the railsexpress
patchsets for rvm, see <a
href="https://github.com/skaes/rvm-patchsets">github.com/skaes/rvm-patchsets</a></p>
@@ -578,45 +577,45 @@
the best results, try to make sure your computer is only performing your
profiling run and is otherwise quiescent.</p>
<p>On both platforms, cpu time is measured using the RDTSC assembly function
provided by the Pentium and PowerPC platforms. CPU time is dependent on the
-cpu’s frequency. On Linux, ruby-prof attempts to read this value from
+cpu's frequency. On Linux, ruby-prof attempts to read this value from
“/proc/cpuinfo.” On Windows, you must manually specify the clock
frequency. This can be done using the RUBY_PROF_CPU_FREQUENCY environment
variable:</p>
<pre>export RUBY_PROF_CPU_FREQUENCY=<value></pre>
<p>You can also directly set the cpu frequency by calling:</p>
<pre>RubyProf.cpu_frequency = <value></pre>
-<h2 id="label-Multi-threaded+Applications">Multi-threaded Applications<span><a href="#label-Multi-threaded+Applications">¶</a> <a href="#documentation">↑</a></span></h2>
+<h2 id="label-Multi-threaded+Applications">Multi-threaded Applications<span><a href="#label-Multi-threaded+Applications">¶</a> <a href="#top">↑</a></span></h2>
<p>Unfortunately, Ruby does not provide an internal api for detecting thread
context switches in 1.8. As a result, the timings ruby-prof reports for
each thread may be slightly inaccurate. In particular, this will happen
for newly spawned threads that go to sleep immediately (their first call).
-For instance, if you use Ruby’s timeout library to wait for 2 seconds, the
-2 seconds will be assigned to the foreground thread and not the newly
+For instance, if you use Ruby's timeout library to wait for 2 seconds,
+the 2 seconds will be assigned to the foreground thread and not the newly
created background thread. These errors can largely be avoided if the
background thread performs any operation before going to sleep.</p>
-<h2 id="label-Performance">Performance<span><a href="#label-Performance">¶</a> <a href="#documentation">↑</a></span></h2>
+<h2 id="label-Performance">Performance<span><a href="#label-Performance">¶</a> <a href="#top">↑</a></span></h2>
-<p>Significant effort has been put into reducing ruby-prof’s overhead as much
-as possible. Our tests show that the overhead associated with profiling
-code varies considerably with the code being profiled. Most programs will
-run approximately twice as slow while highly recursive programs (like the
-fibonacci series test) will run three times slower.</p>
+<p>Significant effort has been put into reducing ruby-prof's overhead as
+much as possible. Our tests show that the overhead associated with
+profiling code varies considerably with the code being profiled. Most
+programs will run approximately twice as slow while highly recursive
+programs (like the fibonacci series test) will run three times slower.</p>
-<h2 id="label-License">License<span><a href="#label-License">¶</a> <a href="#documentation">↑</a></span></h2>
+<h2 id="label-License">License<span><a href="#label-License">¶</a> <a href="#top">↑</a></span></h2>
<p>See <a href="LICENSE.html">LICENSE</a> for license information.</p>
-<h2 id="label-Development">Development<span><a href="#label-Development">¶</a> <a href="#documentation">↑</a></span></h2>
+<h2 id="label-Development">Development<span><a href="#label-Development">¶</a> <a href="#top">↑</a></span></h2>
<p>Code is located at <a
href="https://github.com/ruby-prof/ruby-prof">github.com/ruby-prof/ruby-prof</a></p>
<p>Google group/mailing list: <a
@@ -626,9 +625,9 @@
<footer id="validator-badges" role="contentinfo">
<p><a href="http://validator.w3.org/check/referer">Validate</a>
- <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.0.
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>