Skip to content

[documentation] added how to debug build vpr documentation #2622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.developers.md
Original file line number Diff line number Diff line change
Expand Up @@ -1092,6 +1092,12 @@ All tests passed (1 assertion in 1 test case)
# Debugging Aids
VTR has support for several additional tools/features to aid debugging.

## Basic
To build vpr with make in debug mode, simply add `BUILD_TYPE=debug` at the end of your make command.
```shell
$ make vpr BUILD_TYPE=debug
```

## Sanitizers
VTR can be compiled using *sanitizers* which will detect invalid memory accesses, memory leaks and undefined behaviour (supported by both GCC and LLVM):
```shell
Expand Down