Enabling diagnostics

If you're experiencing issues with clang-tidy, we might ask you to turn on diagnostics as part of the support process. This document describes how to turn on diagnostics and other advanced features.

Turning on diagnostics

Diagnostics are controlled by setting the following registry key:

HKEY_CURRENT_USER\SOFTWARE\RedpointGames\LicenseManager\ClangTidy\EmitDiagnostics = true

You'll need to open regedit.exe, navigate to the HKEY_CURRENT_USER\SOFTWARE\RedpointGames\LicenseManager\ClangTidy folder, and create a new string value called EmitDiagnostics. Set it's value to true.

Now when you run your builds, you'll see a lot of verbose output in the Visual Studio build log window. You'll need to copy the contents of this build log and upload it somewhere for support. You can upload to the License Manager if you need to be able to share a link that is only accessible to support.

To turn off diagnostics, just remove the EmitDiagnostics value from the registry.

Turning on "stop on UBT modify"

If you're modifying the ClangTidyToolchain.cs file, you can make the build stop when UBT is modified or recompiled. This ensures you aren't running the build with an out-of-date UBT executable.

"Stop on UBT modify" is controlled by setting the following registry key:

HKEY_CURRENT_USER\SOFTWARE\RedpointGames\LicenseManager\ClangTidy\StopBuildOnUBTModify = true

You'll need to open regedit.exe, navigate to the HKEY_CURRENT_USER\SOFTWARE\RedpointGames\LicenseManager\ClangTidy folder, and create a new string value called StopBuildOnUBTModify. Set it's value to true.

To turn off "stop on UBT modify", just remove the StopBuildOnUBTModify value from the registry.