Skip to content

Commit

Permalink
How to compile with real-time checking
Browse files Browse the repository at this point in the history
  • Loading branch information
eurobin-project committed Dec 25, 2017
1 parent 7cff498 commit 0ce6625
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions INSTALL.txt
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ To compile, do:
To compile a version that has debugging symbols included, and compiles some tests also:
mkdir -p build_dir_debug; cd build_dir_debug; cmake .. -DCMAKE_BUILD_TYPE=Debug; make VERBOSE=1

When running the code on a real robot, you want to do an optimized build without asserts, i.e. -DCMAKE_BUILD_TYPE=Release

To install libs in /usr/local/lib, headers in /usr/local/include and binaries in dmpbbo/bin:
sudo make install

Expand All @@ -47,12 +49,12 @@ Note that the crash happens towards the very end of the program, just before ret
________________________________________________________________________________
REAL-TIME DEBUGGING BUILD

Various function approximators have been optimized so that no dynamic allocations are made in real-time critical functions. The Eigen matrix library has functionality for checking whether dynamic allocations are made in certain blocks of code. To enable this checking, do:
Various function approximators have been optimized so that no dynamic allocations are made in real-time critical functions. The Eigen matrix library has functionality for checking whether dynamic allocations are made in certain blocks of code.

cmake .. -DREALTIME_CHECKS=1 -DCMAKE_BUILD_TYPE=Debug
To compile a version that has real-time checks built in:
mkdir -p build_dir_realtime; cd build_dir_realtime; cmake .. -DREALTIME_CHECKS=1 -DCMAKE_BUILD_TYPE=Debug; make VERBOSE=1

Note that it doesn't make sense to set -DREALTIME_CHECKS=1 without -DCMAKE_BUILD_TYPE=Debug, as asserts are only done in debug mode.
When running the code on a real robot, clearly you want to do an optimized build without asserts, i.e. -DCMAKE_BUILD_TYPE=Release

________________________________________________________________________________
MANUAL INSTALLATION OF REQUIRED/OPTIONAL PACKAGES
Expand Down

0 comments on commit 0ce6625

Please sign in to comment.