search

modm-io / modm

modm: a C++23 library generator for AVR and ARM Cortex-M devices
https://modm.io
Mozilla Public License 2.0
720 stars 128 forks source link

[docs] Add a reference to "debug mode" in assert.md #1173

Closed TomSaw closed 4 weeks ago

salkinium commented 1 month ago

Yeah, good point.

  1. This should probably be "debug profile", to avoid confusion with using the debugger (eg. scons debug).
  2. There should be a section above "Compiler Options" in https://modm.io/reference/module/modm-build/ that says we have two profiles: release and debug and that they can be selected with the profile=release argument to make and scons (CMake has their own definitions).
TomSaw commented 1 month ago

2. There should be a section above "Compiler Options" in https://modm.io/reference/module/modm-build/ that says we have two profiles: release and debug and that they can be selected with the profile=release argument to make and scons (CMake has their own definitions).

There's even an empty promise in the scons and make docs:

For a description of the release and debug profiles, see the modm:build module documentation.

However, I found clarification in the specific scons and make docs and think this reference is good enough.