Repository navigation
Conversation
…n is generated CMakeLists.txt set EXPORT_COMPILE_COMMANDS (missing the CMAKE_ prefix), which CMake ignores, so compile_commands.json was only produced when -DCMAKE_EXPORT_COMPILE_COMMANDS=ON was passed on the command line.
This branch has not been deployed
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.
What does this PR do?
While setting up the project following CONTRIBUTING.md, I noticed that the documented build steps (here and in the README) don't generate
compile_commands.json, even thoughCMakeLists.txtis meant to ("export compile commands, useful for IDEs"). Line 17 setsEXPORT_COMPILE_COMMANDS, which is missing theCMAKE_prefix, so CMake just ignores it. The pre-commit hook and the CI clang-tidy job don't notice, because they pass-DCMAKE_EXPORT_COMPILE_COMMANDS=ONthemselves.This adds the prefix, so clangd and editors like VS Code pick up the right include paths after a normal build.
Type of change
How was it tested?
On macOS, running
cmake -G Ninja -B _buildwithout the-Dflag: ondevelopthere's no_build/compile_commands.json, and with this change it gets generated.I also did a clean release build of the branch and ran the CLI tests (
test/test_cli.sh), which all pass.ctest --test-dir _build --output-on-failurepasses-Wall -Wextra -Werror)Checklist
clang-format(or the pre-commit hook fromscripts/setup_hooks.sh) (n/a)