[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH] Document CodeQL build requirements

  • To: <win-pv-devel@xxxxxxxxxxxxxxxxxxxx>
  • From: Owen Smith <owen.smith@xxxxxxxxxx>
  • Date: Tue, 7 Sep 2021 09:10:46 +0100
  • Authentication-results: esa2.hc3370-68.iphmx.com; dkim=none (message not signed) header.i=none
  • Cc: Owen Smith <owen.smith@xxxxxxxxxx>
  • Delivery-date: Tue, 07 Sep 2021 08:16:42 +0000
  • Ironport-hdrordr: A9a23:2xY01KqTfFVlDjWP5cj2ny8aV5rveYIsimQD101hICG9Evb0qy nOpoV/6faQslwssR4b9uxoVJPvfZq+z+8W3WByB9eftWDd0QPFEGgL1+DfKlbbak7DH4BmtJ uJc8JFeafN5VoRt7eG3OFveexQvOVu88qT9JjjJ28Gd3APV0n5hT0JcjpyFCdNNW57LKt8Lr WwzOxdqQGtfHwGB/7LfUXsD4D41rv2fIuNW29+OyIa
  • Ironport-sdr: GD9rStSB7h4dUGmRERh62Wc0+1iT0mn8E+zaFQJYXA9NYK9ENCOaJaXc7mu5A6oPtbIC6fGo6M HLdqlZS0TZzDo/dZ6aRG/KZLVC34n9W1GVS4QoKa4gMFfqWvoU+NG3egftj8CO+WoUDOkg7s9w oIIfJNgH7unIToGI3I75HEtS1KaWT751RSxOoO+sI6Gn8EuXeMGtNbqabftf8Vc673jtGHo7qB N4p3i8hY1P0QCl/yovX1c6stNNaQT6PyyQrrVtPtbPOsoFB94oAAXISGxNGoDYYTeVCK3R4Mrx PZp/LlidoqdCRWNAeCdq4MiS
  • List-id: Developer list for the Windows PV Drivers subproject <win-pv-devel.lists.xenproject.org>

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@xxxxxxxxxx>
 BUILD.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/BUILD.md b/BUILD.md
index 574ff98..aeca39e 100644
--- 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 
 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
+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



Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.