Skip to content

Commit

Permalink
[ci skip] Add documentation on leak checker script
Browse files Browse the repository at this point in the history
  • Loading branch information
ben-marshall committed Jul 25, 2016
1 parent c4d4169 commit f1b1ae8
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/project-organisation.dox
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,15 @@ From either of those directories, we can run the following commands:
- `make coverage-report` - Runs the coverage suite against the most recent
build, and puts the results in `./build/coverage/`

@section memory-leaks Memory Leaks

There is a tool script in `bin/` called `leakcheck-report.sh` which should be
run from the project root directory.

It runs a subset of the tests through the parser, assisted by valgrind. It
checks for all memory leaks and their origins, putting the resulting log
into the `build` folder.

@section ci-tool Continuous Integration

This project uses the Travis-CI tool for continuous integration. This is
Expand Down

0 comments on commit f1b1ae8

Please sign in to comment.