1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOC] Document Thread::Backtrace.limit

Browse Source
This commit is contained in:
zverok 2021-12-20 09:07:25 +02:00 committed by Jeremy Evans
parent 37aea9d798
commit 81f08edbd6
Notes: git 2021-12-21 01:56:27 +09:00 
Merged: https://github.com/ruby/ruby/pull/5305
1 changed files with 55 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
vm_backtrace.c
View File

@ -782,6 +782,56 @@ backtrace_load_data(VALUE self, VALUE str)
return self; return self;
} }
/*
* call-seq: Threade::Backtrace::limit -> integer
*
* Returns maximum backtrace length set by <tt>--backtrace-limit</tt>
* command-line option. The defalt is <tt>-1</tt> which means unlimited
* backtraces. If the value is zero or positive, the error backtraces,
* produced by Exception#full_message, are abbreviated and the extra lines
* are replaced by <tt>... 3 levels... </tt>
*
* $ ruby -r net/http -e "p Thread::Backtrace.limit; Net::HTTP.get(URI('http://wrong.address'))"
* - 1
* .../lib/ruby/3.1.0/socket.rb:227:in `getaddrinfo': Failed to open TCP connection to wrong.address:80 (getaddrinfo: Name or service not known) (SocketError)
* from .../lib/ruby/3.1.0/socket.rb:227:in `foreach'
* from .../lib/ruby/3.1.0/socket.rb:632:in `tcp'
* from .../lib/ruby/3.1.0/net/http.rb:998:in `connect'
* from .../lib/ruby/3.1.0/net/http.rb:976:in `do_start'
* from .../lib/ruby/3.1.0/net/http.rb:965:in `start'
* from .../lib/ruby/3.1.0/net/http.rb:627:in `start'
* from .../lib/ruby/3.1.0/net/http.rb:503:in `get_response'
* from .../lib/ruby/3.1.0/net/http.rb:474:in `get'
* .../lib/ruby/3.1.0/socket.rb:227:in `getaddrinfo': getaddrinfo: Name or service not known (SocketError)
* from .../lib/ruby/3.1.0/socket.rb:227:in `foreach'
* from .../lib/ruby/3.1.0/socket.rb:632:in `tcp'
* from .../lib/ruby/3.1.0/net/http.rb:998:in `connect'
* from .../lib/ruby/3.1.0/net/http.rb:976:in `do_start'
* from .../lib/ruby/3.1.0/net/http.rb:965:in `start'
* from .../lib/ruby/3.1.0/net/http.rb:627:in `start'
* from .../lib/ruby/3.1.0/net/http.rb:503:in `get_response'
* from .../lib/ruby/3.1.0/net/http.rb:474:in `get'
* from -e:1:in `<main>'
*
* $ ruby --backtrace-limit 2 -r net/http -e "p Thread::Backtrace.limit; Net::HTTP.get(URI('http://wrong.address'))"
* 2
* .../lib/ruby/3.1.0/socket.rb:227:in `getaddrinfo': Failed to open TCP connection to wrong.address:80 (getaddrinfo: Name or service not known) (SocketError)
* from .../lib/ruby/3.1.0/socket.rb:227:in `foreach'
* from .../lib/ruby/3.1.0/socket.rb:632:in `tcp'
* ... 7 levels...
* .../lib/ruby/3.1.0/socket.rb:227:in `getaddrinfo': getaddrinfo: Name or service not known (SocketError)
* from .../lib/ruby/3.1.0/socket.rb:227:in `foreach'
* from .../lib/ruby/3.1.0/socket.rb:632:in `tcp'
* ... 7 levels...
*
* $ ruby --backtrace-limit 0 -r net/http -e "p Thread::Backtrace.limit; Net::HTTP.get(URI('http://wrong.address'))"
* 0
* .../lib/ruby/3.1.0/socket.rb:227:in `getaddrinfo': Failed to open TCP connection to wrong.address:80 (getaddrinfo: Name or service not known) (SocketError)
* ... 9 levels...
* .../lib/ruby/3.1.0/socket.rb:227:in `getaddrinfo': getaddrinfo: Name or service not known (SocketError)
* ... 9 levels...
*
*/
static VALUE static VALUE
backtrace_limit(VALUE self) backtrace_limit(VALUE self)
{ {
@ -1194,7 +1244,11 @@ rb_f_caller_locations(int argc, VALUE *argv, VALUE _)
void void
Init_vm_backtrace(void) Init_vm_backtrace(void)
{ {
/* :nodoc: */ /*
* An internal representation of the backtrace. The user will never interact with
* objects of this class directly, but class methods can be used to get backtrace
* settings of the current session.
*/
rb_cBacktrace = rb_define_class_under(rb_cThread, "Backtrace", rb_cObject); rb_cBacktrace = rb_define_class_under(rb_cThread, "Backtrace", rb_cObject);
rb_define_alloc_func(rb_cBacktrace, backtrace_alloc); rb_define_alloc_func(rb_cBacktrace, backtrace_alloc);
rb_undef_method(CLASS_OF(rb_cBacktrace), "new"); rb_undef_method(CLASS_OF(rb_cBacktrace), "new");