Update the readme to add boehm and debug instructions for it

This commit is contained in:
Sameer Rahmani 2022-07-06 20:04:39 +01:00
parent 05d39d367d
commit 3a9b69b9d2
1 changed files with 14 additions and 0 deletions

View File

@ -17,6 +17,7 @@ Setup the githook and install dependencies using the following commands:
- doxygen (If you want to build the docs as well)
- Valgrind
- CCache (If you want faster builds specially with the LLVM)
- Boehm GC v8.2.0
** LLVM Installation
@ -87,6 +88,19 @@ the project once and then you can just use =./builder compile= to build the chan
Check out the =builder= script for more subcommands and details.
* How to Debug
Since we're using the Boehm GC, in order to use a debugger we need to turn off some of the signal
handlers that the debugger sets. In order to run the debugger (by default lldb) with ~serenec~
just use the ~lldb-run~ subcommand of the builder script. In the debugger, after setting the
break point on the ~main~ function (~b main~) then use the following commands on:
#+BEGIN_SRC bash
process handle -p yes -s no -n no SIGPWR
process handle -p yes -s no -n no SIGXCPU
process handle -p yes -s no -n no SIGSEGV
#+END_SRC bash
* Cheatsheets
- [[https://github.com/muqsitnawaz/modern-cpp-cheatsheet][Modern C++ Cheatsheet]]