docs: document debug CMake builds#4907
Open
kiwigitops wants to merge 1 commit into
Open
Conversation
cc0fb77 to
0e1ccd3
Compare
causten
approved these changes
May 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
README source-build instructions document the default CMake flow, but they do not show how to build MIGraphX in debug mode even though the project defaults
CMAKE_BUILD_TYPEtoRelease. This addresses the missing debug-build guidance requested in #958.Technical Details
-DCMAKE_BUILD_TYPE=Debugin the CMake build section.RelWithDebInfofor optimized builds that still include debug symbols.Why this adds value: developers can now configure debug or debug-symbol builds without reading
CMakeLists.txtor guessing the supported CMake build types.Validation performed:
git diff --checkDocumentation updated:
README.mdChecks not run:
Changelog Category
Add a
CHANGELOG.mdentry for any option other thanNot ApplicableCloses #958