Skip to content

Commit

Permalink
Revert "Update README"
Browse files Browse the repository at this point in the history
This reverts commit 2d4c763.
  • Loading branch information
chrisyuska committed Mar 18, 2022
1 parent 57fdbba commit 816aa43
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Then run `$ bundle install`. Alternatively you can run `$ gem install stackprof`
in ruby:

``` ruby
StackProf.run(mode: :cpu, path: 'tmp/stackprof-cpu-myapp.dump') do
StackProf.run(mode: :cpu, out: 'tmp/stackprof-cpu-myapp.dump') do
#...
end
```
Expand Down Expand Up @@ -119,15 +119,15 @@ Samplers have a tuneable interval which can be used to reduce overhead or increa
- Wall time: sample every _interval_ microseconds of wallclock time (default: 1000)

```ruby
StackProf.run(mode: :wall, path: 'tmp/stackprof.dump', interval: 1000) do
StackProf.run(mode: :wall, out: 'tmp/stackprof.dump', interval: 1000) do
#...
end
```

- CPU time: sample every _interval_ microseconds of CPU activity (default: 1000 = 1 millisecond)

```ruby
StackProf.run(mode: :cpu, path: 'tmp/stackprof.dump', interval: 1000) do
StackProf.run(mode: :cpu, out: 'tmp/stackprof.dump', interval: 1000) do
#...
end
```
Expand All @@ -136,7 +136,7 @@ end


```ruby
StackProf.run(mode: :object, path: 'tmp/stackprof.dump', interval: 1) do
StackProf.run(mode: :object, out: 'tmp/stackprof.dump', interval: 1) do
#...
end
```
Expand Down Expand Up @@ -331,7 +331,7 @@ StackProf.results('/tmp/some.file')
Option | Meaning
------- | ---------
`mode` | Mode of sampling: `:cpu`, `:wall`, `:object`, or `:custom` [c.f.](#sampling)
`path` | The target file, which will be overwritten
`out` | The target file, which will be overwritten
`interval` | Mode-relative sample rate [c.f.](#sampling)
`ignore_gc` | Ignore garbage collection frames
`aggregate` | Defaults: `true` - if `false` disables [aggregation](#aggregation)
Expand Down

0 comments on commit 816aa43

Please sign in to comment.