Skip to content

Commit

Permalink
doc: update CONTRIBUTING with info about test:memory_suite
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
flavorjones committed Jan 16, 2024
1 parent c354b82 commit e4416e6
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,13 +172,20 @@ bundle exec rake compile test:lldb
```


Run tests and look for new memory leaks:
Run tests and look for memory leaks with valgrind and ruby_memcheck:

``` sh
bundle exec rake compile test:memcheck
```


Run test/test_memory_usage.rb and look for memory leaks using RSS size and linear interpolation:

``` sh
bundle exec rake compile test:memory_suite
```


Note that by you can run the test suite with a variety of GC behaviors. For example, running a major after each test completes has, on occasion, been useful for localizing some classes of memory bugs, but does slow the suite down. Some variations of the test suite behavior are available (see `test/helper.rb` for more info):

``` sh
Expand Down

0 comments on commit e4416e6

Please sign in to comment.