kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

[DOC] Marked dtrace arguments as description list [ci skip]

Browse source
This commit is contained in:
Nobuyoshi Nakada 2020-12-19 15:32:06 +09:00
parent a5832c9a37
commit 553d6fa0a0
No known key found for this signature in database
GPG key ID: 7CD2805BFA3770C6
1 changed files with 36 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

72
doc/dtrace_probes.rdoc
View file

@ -52,10 +52,10 @@ with when they are fired and the arguments they take:
[ruby:::method-entry(classname, methodname, filename, lineno);] [ruby:::method-entry(classname, methodname, filename, lineno);]
This probe is fired just before a method is entered. This probe is fired just before a method is entered.
classname name of the class (a string) classname:: name of the class (a string)
methodname name of the method about to be executed (a string) methodname:: name of the method about to be executed (a string)
filename the file name where the method is _being called_ (a string) filename:: the file name where the method is _being called_ (a string)
lineno the line number where the method is _being called_ (an int) lineno:: the line number where the method is _being called_ (an int)
*NOTE*: will only be fired if tracing is enabled, e.g. with: <code>TracePoint.new{}.enable</code>. *NOTE*: will only be fired if tracing is enabled, e.g. with: <code>TracePoint.new{}.enable</code>.
See Feature#14104[https://bugs.ruby-lang.org/issues/14104] for more details. See Feature#14104[https://bugs.ruby-lang.org/issues/14104] for more details.
@ -78,9 +78,9 @@ with when they are fired and the arguments they take:
[ruby:::require-entry(requiredfile, filename, lineno);] [ruby:::require-entry(requiredfile, filename, lineno);]
This probe is fired on calls to rb_require_safe (when a file is required). This probe is fired on calls to rb_require_safe (when a file is required).
requiredfile is the name of the file to be required (string). requiredfile:: the name of the file to be required (string).
filename is the file that called "require" (string). filename:: the file that called "+require+" (string).
lineno is the line number where the call to require was made (int). lineno:: the line number where the call to require was made (int).
[ruby:::require-return(requiredfile, filename, lineno);] [ruby:::require-return(requiredfile, filename, lineno);]
This probe is fired just before rb_require_safe (when a file is required) This probe is fired just before rb_require_safe (when a file is required)
@ -90,11 +90,11 @@ with when they are fired and the arguments they take:
[ruby:::find-require-entry(requiredfile, filename, lineno);] [ruby:::find-require-entry(requiredfile, filename, lineno);]
This probe is fired right before search_required is called. search_required This probe is fired right before search_required is called. search_required
determines whether the file has already been required by searching loaded determines whether the file has already been required by searching loaded
features ($"), and if not, figures out which file must be loaded. features (<code>$"</code>), and if not, figures out which file must be loaded.
requiredfile is the file to be required (string). requiredfile:: the file to be required (string).
filename is the file that called "require" (string). filename:: the file that called "require" (string).
lineno is the line number where the call to require was made (int). lineno:: the line number where the call to require was made (int).
[ruby:::find-require-return(requiredfile, filename, lineno);] [ruby:::find-require-return(requiredfile, filename, lineno);]
This probe is fired right after search_required returns. See the This probe is fired right after search_required returns. See the
@ -112,56 +112,56 @@ with when they are fired and the arguments they take:
[ruby:::raise(classname, filename, lineno);] [ruby:::raise(classname, filename, lineno);]
This probe is fired when an exception is raised. This probe is fired when an exception is raised.
classname is the class name of the raised exception (string) classname:: the class name of the raised exception (string)
filename the name of the file where the exception was raised (string) filename:: the name of the file where the exception was raised (string)
lineno the line number in the file where the exception was raised (int) lineno:: the line number in the file where the exception was raised (int)
[ruby:::object-create(classname, filename, lineno);] [ruby:::object-create(classname, filename, lineno);]
This probe is fired when an object is about to be allocated. This probe is fired when an object is about to be allocated.
classname the class of the allocated object (string) classname:: the class of the allocated object (string)
filename the name of the file where the object is allocated (string) filename:: the name of the file where the object is allocated (string)
lineno the line number in the file where the object is allocated (int) lineno:: the line number in the file where the object is allocated (int)
[ruby:::array-create(length, filename, lineno);] [ruby:::array-create(length, filename, lineno);]
This probe is fired when an Array is about to be allocated. This probe is fired when an Array is about to be allocated.
length the size of the array (long) length:: the size of the array (long)
filename the name of the file where the array is allocated (string) filename:: the name of the file where the array is allocated (string)
lineno the line number in the file where the array is allocated (int) lineno:: the line number in the file where the array is allocated (int)
[ruby:::hash-create(length, filename, lineno);] [ruby:::hash-create(length, filename, lineno);]
This probe is fired when a Hash is about to be allocated. This probe is fired when a Hash is about to be allocated.
length the size of the hash (long) length:: the size of the hash (long)
filename the name of the file where the hash is allocated (string) filename:: the name of the file where the hash is allocated (string)
lineno the line number in the file where the hash is allocated (int) lineno:: the line number in the file where the hash is allocated (int)
[ruby:::string-create(length, filename, lineno);] [ruby:::string-create(length, filename, lineno);]
This probe is fired when a String is about to be allocated. This probe is fired when a String is about to be allocated.
length the size of the string (long) length:: the size of the string (long)
filename the name of the file where the string is allocated (string) filename:: the name of the file where the string is allocated (string)
lineno the line number in the file where the string is allocated (int) lineno:: the line number in the file where the string is allocated (int)
[ruby:::symbol-create(str, filename, lineno);] [ruby:::symbol-create(str, filename, lineno);]
This probe is fired when a Symbol is about to be allocated. This probe is fired when a Symbol is about to be allocated.
str the contents of the symbol (string) str:: the contents of the symbol (string)
filename the name of the file where the string is allocated (string) filename:: the name of the file where the string is allocated (string)
lineno the line number in the file where the string is allocated (int) lineno:: the line number in the file where the string is allocated (int)
[ruby:::parse-begin(sourcefile, lineno);] [ruby:::parse-begin(sourcefile, lineno);]
Fired just before parsing and compiling a source file. Fired just before parsing and compiling a source file.
sourcefile the file being parsed (string) sourcefile:: the file being parsed (string)
lineno the line number where the source starts (int) lineno:: the line number where the source starts (int)
[ruby:::parse-end(sourcefile, lineno);] [ruby:::parse-end(sourcefile, lineno);]
Fired just after parsing and compiling a source file. Fired just after parsing and compiling a source file.
sourcefile the file being parsed (string) sourcefile:: the file being parsed (string)
lineno the line number where the source ended (int) lineno:: the line number where the source ended (int)
[ruby:::gc-mark-begin();] [ruby:::gc-mark-begin();]
Fired at the beginning of a mark phase. Fired at the beginning of a mark phase.
@ -178,7 +178,7 @@ with when they are fired and the arguments they take:
[ruby:::method-cache-clear(class, sourcefile, lineno);] [ruby:::method-cache-clear(class, sourcefile, lineno);]
Fired when the method cache is cleared. Fired when the method cache is cleared.
class is the classname being cleared, or "global" (string) class:: the classname being cleared, or "global" (string)
sourcefile the file being parsed (string) sourcefile:: the file being parsed (string)
lineno the line number where the source ended (int) lineno:: the line number where the source ended (int)