Skip to content

Commit 88e1aa1

Browse files
author
Vaughn Betz
committed
Added basic information on building with debug information and turning on verbosity to the developer guide.
1 parent 3bc580c commit 88e1aa1

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.developers.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1131,11 +1131,17 @@ All tests passed (1 assertion in 1 test case)
11311131
VTR has support for several additional tools/features to aid debugging.
11321132

11331133
## Basic
1134-
To build vpr with make in debug mode, simply add `BUILD_TYPE=debug` at the end of your make command.
1134+
To build a tool with make in debug mode, simply add `BUILD_TYPE=debug` at the end of your make command. For example, to build all tools in debug mode use:
11351135
```shell
1136-
$ make vpr BUILD_TYPE=debug
1136+
$ make BUILD_TYPE=debug
11371137
```
11381138

1139+
You can also enable additional (verbose) output from some tools. To build vpr with both debug information and additional output, use:
1140+
```shell
1141+
$ make vpr BUILD_TYPE=debug VERBOSE=1
1142+
```
1143+
1144+
11391145
## Sanitizers
11401146
VTR can be compiled using *sanitizers* which will detect invalid memory accesses, memory leaks and undefined behaviour (supported by both GCC and LLVM):
11411147
```shell

0 commit comments

Comments
 (0)