Permalink
Browse files

DRY up reports info

  • Loading branch information...
1 parent 943ed8a commit 16e9bba01bdde5d114b3e4790ac75ca5345dfc63 @rdp rdp committed May 14, 2011
Showing with 7 additions and 1 deletion.
  1. +6 −0 README.rdoc
  2. +1 −1 bin/ruby-prof
View
@@ -10,6 +10,7 @@ ruby-prof is a fast code profiler for Ruby. Its features include:
- Flat Profiles - similar to the reports generated by the standard Ruby profiler
- Graph profiles - similar to GProf, these show how long a method runs, which methods call it and which methods it calls.
- Call tree profiles - outputs results in the calltree format suitable for the KCacheGrind profiling tool.
+ - Many more -- see reports section of this README.
* Threads - supports profiling multiple threads simultaneously
== Requirements
@@ -248,6 +249,8 @@ are a good of quickly identifying which methods take the most time.
An example of a flat profile and an explanation can be found in
{examples/flat.txt}[http://github.com/rdp/ruby-prof/tree/master/examples/flat.txt].
+There are several varieties of these -- run $ ruby-prof --help
+
Graph profiles also show the overall time spent in each method. In
addition, they also show which methods call the current method and which
methods its calls. Thus they are good for understanding how methods
@@ -271,10 +274,13 @@ Call stack reports produce a HTML visualization of the time spent in
each execution path of the profiled code. An example can be found at
{examples/stack.html}[http://github.com/rdp/ruby-prof/tree/master/examples/call_stack.html].
+Another good example: [http://twitpic.com/28z94a]
+
Finally, there's a so called MultiPrinter which can generate several
reports in one profiling run. See
{examples/multi.stack.html}[http://github.com/rdp/ruby-prof/tree/master/examples/multi.stack.html].
+There is also a graphviz .dot visualiser.
== Printers
View
@@ -11,7 +11,7 @@
# Various options:
# run "$ ruby-prof --help" to see them
#
-# See also: {flat profiles}[link:files/examples/flat_txt.html], {graph profiles}[link:files/examples/graph_txt.html], {html graph profiles}[link:files/examples/graph_html.html]
+# See also the readme "reports" section for the various outputs
require 'ostruct'
require 'optparse'

0 comments on commit 16e9bba

Please sign in to comment.