@@ -27,7 +27,7 @@ Then run `$ bundle install`. Alternatively you can run `$ gem install stackprof`
2727in ruby:
2828
2929``` ruby
30- StackProf .run(mode: :cpu , path : ' tmp/stackprof-cpu-myapp.dump' ) do
30+ StackProf .run(mode: :cpu , out : ' tmp/stackprof-cpu-myapp.dump' ) do
3131 # ...
3232end
3333```
@@ -119,15 +119,15 @@ Samplers have a tuneable interval which can be used to reduce overhead or increa
119119 - Wall time: sample every _ interval_ microseconds of wallclock time (default: 1000)
120120
121121``` ruby
122- StackProf .run(mode: :wall , path : ' tmp/stackprof.dump' , interval: 1000 ) do
122+ StackProf .run(mode: :wall , out : ' tmp/stackprof.dump' , interval: 1000 ) do
123123 # ...
124124end
125125```
126126
127127 - CPU time: sample every _ interval_ microseconds of CPU activity (default: 1000 = 1 millisecond)
128128
129129``` ruby
130- StackProf .run(mode: :cpu , path : ' tmp/stackprof.dump' , interval: 1000 ) do
130+ StackProf .run(mode: :cpu , out : ' tmp/stackprof.dump' , interval: 1000 ) do
131131 # ...
132132end
133133```
136136
137137
138138``` ruby
139- StackProf .run(mode: :object , path : ' tmp/stackprof.dump' , interval: 1 ) do
139+ StackProf .run(mode: :object , out : ' tmp/stackprof.dump' , interval: 1 ) do
140140 # ...
141141end
142142```
@@ -331,7 +331,7 @@ StackProf.results('/tmp/some.file')
331331Option | Meaning
332332------- | ---------
333333` mode ` | Mode of sampling: ` :cpu ` , ` :wall ` , ` :object ` , or ` :custom ` [ c.f.] ( #sampling )
334- ` path ` | The target file, which will be overwritten
334+ ` out ` | The target file, which will be overwritten
335335` interval ` | Mode-relative sample rate [ c.f.] ( #sampling )
336336` ignore_gc ` | Ignore garbage collection frames
337337` aggregate ` | Defaults: ` true ` - if ` false ` disables [ aggregation] ( #aggregation )
0 commit comments