Document CodeQL build requirements

CodeQL requires an additional tool and rule set which are seperate from the
EWDK ISOs, and require manual installation and configuration

Signed-off-by: Owen Smith <owen.smith@citrix.com>

diff --git a/BUILD.md b/BUILD.md
index 0cbabf193c5c672e26a41dbd23613ab011260319..e82da2b79f9eb36e178c13c9de140c317a310b1b 100644 (file)
--- a/BUILD.md
+++ b/BUILD.md
@@ -7,6 +7,7 @@ ISO containing all the build environment you need.
 
 The package should support building with the following EWDKs:
 
+- EWDK for Server 2022, version 22000 with Visual Studio Build Tools 16.9
 - EWDK for Windows 10, version 1903 with Visual Studio Build Tools 16.0
 - EWDK for Windows 10, version 1809 with Visual Studio Build Tools 15.8.9
 
@@ -29,3 +30,14 @@ by default. However, if you set the environment variable DPINST_REDIST to
 point to a directory with x86 and x64 sub-directories containing 32- and
 64-bit dpinst.exe binaries (respectively) then these will be copied into
 the built packages, making installation more convenient.
+
+NOTE: In order to use the '-CodeQL' parameter to generate *.sarif log files,
+an additional tool and set of rules will need installing. The CodeQL engine
+can be downloaded from https://github.com/github/codeql-cli-binaries/releases
+and the driver specific rules can be cloned from
+https://github.com/microsoft/Windows-Driver-Developer-Supplemental-Tools.
+Once acquired, the rules need to be in a sibling folder of the engine (e.g.
+C:\Tools\CodeQL and C:\Tools\Windows-Driver-Developer-Supplemental-Tools) and
+the CodeQL engine (e.g. C:\Tools\CodeQL) must be added to the PATH environment
+variable. Further information available at
+https://docs.microsoft.com/en-us/windows-hardware/drivers/devtest/static-tools-and-codeql