Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Jun 30, 2024

Conversation

TomSaw
Copy link
Contributor

@TomSaw TomSaw commented Jun 29, 2024

No description provided.

Copy link
Member

@rleh rleh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your link links to the scons bud system documentation, but the debug mode is build system independent.
There is this page (https://modm.io/reference/module/modm-build/), but it does not explain how to use the debug/release build modes.
I'm not sure what the best solution is.

@salkinium
Copy link
Member

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
Copy link
Contributor Author

TomSaw commented Jun 29, 2024

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.

@TomSaw TomSaw force-pushed the patch-1 branch 2 times, most recently from 00703e0 to 91f09b0 Compare June 29, 2024 19:27
Copy link
Member

@salkinium salkinium left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@salkinium salkinium merged commit 7a8c57d into modm-io:develop Jun 30, 2024
12 checks passed
@TomSaw TomSaw deleted the patch-1 branch July 2, 2024 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants