| name | debugging |
| description | Debugging conventions for pikru. Use when adding debug traces or investigating issues. Important rule - leave debug traces in place. |
Debugging
When in doubt, add tracing:
- C code:
DBG()macro - Rust code:
tracing::debug!()(noteprintln!)
IMPORTANT: Leave debug traces in place!
- DO NOT remove
DBG()calls from C code after debugging - DO NOT remove
tracing::debug!()calls from Rust code after debugging - DO NOT run
make cleanin vendor/pikchr-c (it's disabled anyway)
Rationale
- The C implementation is not used in production - debug traces are helpful for future investigations
- Rust tracing can be turned on/off at compile time via
RUST_LOGenvironment variable - Having traces in place makes future debugging much faster