Troubleshooting CMake Tools¶
CMake Tools, like any piece of software, may misbehave. There are several thingsto do to check what is going wrong.
Note
Should any of the below actions be necessary for any reasonbe aware thatyou have encountered a bug.
If CMake Tools hasn’t given you a useful help or error message, or hasbehaved in a counter-intuitive way without being otherwise documented, thenthe behavior canand should be considered a bug.
Please visitthe support chat, and/orcheck for or open a relevantGitHub issue.
Reset the Extension State¶
CMake Tools persists certain workspace settings in an internalmemento that isopaque to the user. This includes things like the active target and variant.If this state were to somehow be corrupted or inconsistent, this state can bereset via theCMake: Reset CMake Tools extension state command.
Warning
Resetting the state will automatically reload the current workspace!
Increasing the Log Level¶
CMake Tools exposes a lot of optional logging that isn’t enabled by default.Thecmake.loggingLevel setting can be used to increase the amount ofoutput written to theCMake/Build output channel.
Checking the Log File¶
Regardless of the user-visible log level, CMake Tools writes all log entries forall levels to a user-local log file. This file can be opened with theCMake: Open the CMake Tools log file command.
Note
This file is user-local,not workspace-local. This file includes all logentries since the extension was installed. It may be very large.
Check for a GitHub Issue¶
It is possible that other users have encountered the same problem before.Check the GitHub issues list for others encountering the same problem thatyou have.
Ask Around the Support Chat¶
CMake Tools hasa Gitter chat room for end-user support.
Note
People in this chat are volunteers and may not be available at all times ofthe day. Please be patient.
Open a GitHub Issue¶
Issue reports are very welcome! CMake Tools is developed and maintained entirelyby volunteer work, so there is no rigorous QA process. End-user issue reportsare all we have to go on!
And remember: If your question isn’t answered in this documentation,that’s a documentation bug!