README in backtracer-0.0.2 vs README in backtracer-0.1.0
- old
+ new
@@ -1,110 +1,39 @@
-ruby_backtracer: output higher quality backtraces if an unhandled exception occurs. Originally inspired by the frustration of seeling ...24 levels... a few too many times.
+ruby_backtracer: a library to output higher quality backtraces if an unhandled exception is raised
-There are several options available (the more verbose ones rely on ruby-debug, which slows things down a bit).
-
-ex:
-a script used to output:
+ex:
+running given script examples/crash.rb used to output:
examples>ruby crash.rb
crash.rb:2:in `go2': unhandled exception
from crash.rb:6:in `go'
from crash.rb:9
-Using backtracer, it now outputs:
-examples>ruby -rbacktracer_locals crash.rb
+now outputs:
+examples>ruby -r../backtrace_with_code_and_locals crash.rb
unhandled exception: crash.rb:2: raise
locals: {"a"=>"3", "b"=>55}
from:
crash.rb:1 go2(a=>3, b=>55)
locals: {"a"=>"3", "b"=>55}
crash.rb:5 go(a=>3)
locals: {"a"=>"3"}
-or
-examples>ruby -rbacktracer crash.rb
-====
-crash.rb:2:in `go2'
- raise
-crash.rb:7:in `go'
- go2(a, 55)
-crash.rb:10
- go '3'
-====
-crash.rb:2:in `go2': unhandled exception
- from crash.rb:7:in `go'
- from crash.rb:10
+Now wasn't that prettier?
-All the options are backtracer, backtracer_locals, backtracer_simple, backtracer_tracer
+There are several other tracing options provided, if you don't want as much output, or want more speed. Specify which by script name.
+ex: backtrace_nothing_swallowed.rb outputs the same as the default exception output, except it doesn't have the
+...skip 24 lines...
+line in the middle (also no speed slowdown, and no local variables displayed).
-== Installation ==
+Try them out by running test_all.rb in the examples folder, or eyeball the example output files in examples/example_output*
-== 1.9 ==
+http://github.com/rogerdpack/ruby_backtracer/tree/master
-$ gem install ruby-debug19
-$ gem sources add http://gemcutter.org # if necessary
-$ gem install backtracer
+Note: some options depends on ruby-debug [MRI] gem, some don't.
-run as above
-$ ruby -rbacktracer script_name
+To install clone from github, above, then ruby -rscriptname your_script.
-== 1.8.x ==
+related projects: unroller, http://eigenclass.org/hiki/method+arguments+via+introspection, liveconsole, ruby-debug
-$ gem install ruby-debug
-$ gem sources add http://gemcutter.org # if necessary
-$ sudo gem install faster_rubygems # necessary to be able to load gems from the command line -- installs the file rubygemsf into your site_ruby
-$ gem install backtracer
-
-now run them like
-$ ruby -rubygemsf -rbacktracer script_name
-
-the rubygemsf is necessary because for some reason running
-$ ruby -rubygems -rbacktracer script_name
-
-fails [probably a bug in ruby]
-
-== Descriptions ==
-
-Try these out if desired:
-create a file like:
-
- def go(a)
- raise
- end
- go(3)
-
-then run ruby against it like
-
-ruby -rbacktracer name
- outputs full backtrace with code of each line [a la Python]
-ruby -rbacktracer_locals name
- outputs full backtrace with local variables and parameters
-ruby -rbacktracer_simple name
- outputs backtrace without the ...24 levels... [yea!]
-ruby -backtracer_tracer name
- same as backtracer_locals except it shows traces of calls as they're made
-
-
-or in 1.8.x
-ruby -rubygemsf -rbacktracer name
-etc.
-
-
-== Other ==
-
-Note that you can [if desired] load these within a script iself
-require 'backtracer'
-
-and it will output a backtrace if one exists at exit time.
-
-You can also add it to your RUBYOPT variable if you always want it to run [backtracer_simple and backtracer don't cause any slowdown].
-$ export RUBYOPT=-rbacktracer
-
-if desired.
-
-== Related projects ==
-unroller, http://eigenclass.org/hiki/method+arguments+via+introspection, liveconsole, ruby-debug
-
-Comments welcome to rdp on github.
-
-http://github.com/rdp/backtracer
\ No newline at end of file
+send comments to rogerdpack on github.