README.rdoc in tracepoint-1.2.0 vs README.rdoc in tracepoint-1.2.1

- old
+ new

@@ -1,28 +1,35 @@ = TracePoint -== RESOURCES +{Home}[http://rubyworks.github.com/tracepoint] | +{Code}[http://github.com/rubyworks/tracepoint] | +{Mail}[http://google.groups.com/group/rubyworks-mailinglist] -* home: http://rubyworks.github.com/tracepoint -* code: http://github.com/rubyworks/tracepoint +{<img src="http://travis-ci.org/rubyworks/tracepoint.png" />}[http://travis-ci.org/rubyworks/tracepoint] -== DESCRIPTION +== Description TracePoint is a Binding with the addition of event information. In theory it would function very well as the join-point for AOP. In practice it provides a better approach to #set_trace_func. +IMPOTRANT! TracePoint does not *fully* work under Ruby 1.9.0-1.9.3, +not because there is anything wrong with TracePoint, but because +Ruby 1.9 has a bug in `#set_trace_func` in which the binding parameter +is incorrect. -== FEATURES -* More versitle than #set_trace_func. -* Easy to set mutliple traces. +== Features +* More versatile than #set_trace_func. +* Easy to set multiple traces. +* Can activate and deactivate traces on the fly. -== SYNOPSIS +== Synopsis + Using TracePoint is simply a matter of setting the #trace procedure. For example to watch everything that happens during a Ruby process: TracePoint.trace do |tp| puts "#{tp.self.class}\t#{tp.callee}\t#{tp.event}\t#{tp.return?}" @@ -36,11 +43,11 @@ Object line false Fixnum + c-call false Fixnum + c-return false -Tracing can be deactived and reactivated on the fly by calling #deactivate +Tracing can be deactivated and reactivated on the fly by calling #deactivate and #activate. To add additional trace procedures, simply call the #trace method again. Trace procedures can also be named by providing a name argument to the #trace method. This allows traces to be added and removed without affecting @@ -62,31 +69,24 @@ deactivate tracing. Please see the API documentation for more information. -== INSTALLATION +== Install Follow the usual procedure for installing via RubyGems: - $ sudo gem install tracepoint + $ gem install tracepoint -== LICENSE +== Copyrights -(Apache 2.0 License) +(BSD-2-Clause License) -Copyright (c) 2005,2010 Thomas Sawyer +Copyright (c) 2005,2010 Rubyworks, Thomas Sawyer -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use any of the files packaged with this file -except in compliance with this License. You may obtain a copy -of the License at +TracePoint is distributable in accordance with the terms of the *FreeBSD* license. - http://www.apache.org/licenses/LICENSE-2.0 +See COPYING.rdoc for details. -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. +