docs: Notes on working with c

lcm-proj · May 12, 2024 · e72f1ba · e72f1ba
1 parent 2b7f0fc
commit e72f1ba
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/docs/content/contributing-c.md b/docs/content/contributing-c.md
@@ -2,6 +2,17 @@
 
 Run `./format_code.sh` before committing to format the code.
 
+Configure with `cmake .. -DCMAKE_BUILD_TYPE=Debug` or `cmake .. -DCMAKE_BUILD_TYPE=RelWithDebInfo` to debug.
+
+
+Modifying lcm-gen does not rebuild the tests. [#490](https://github.com/lcm-proj/lcm/issues/490). The following is a workaround:
+
+```bash
+cd build
+rm -r test && make -j
+make test
+```
+
 ## Code Quality
 
-Code in the directory `lcmgen` leaks memory. It is not an uncommon practice to allow this for short lived CLI tools. 
+Code in the directory `lcmgen` leaks memory. It is not an uncommon practice to allow this for short lived CLI tools. It is preferred to avoid and clean up after this practice though. [#484](https://github.com/lcm-proj/lcm/issues/484).