Document that the only supported dependency commits are the ones in known_good.json

This commit is contained in:
Chris Djali 2024-02-19 16:26:07 +00:00 committed by GitHub
parent d84255296c
commit 6340ba901a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 4 additions and 1 deletions

View file

@ -283,7 +283,7 @@ if(BUILD_EXTERNAL AND IS_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/External)
add_subdirectory(External) add_subdirectory(External)
endif() endif()
option(ALLOW_EXTERNAL_SPIRV_TOOLS "Allows to build against installed SPIRV-Tools-opt") option(ALLOW_EXTERNAL_SPIRV_TOOLS "Allows to build against installed SPIRV-Tools-opt. This is unsupported if the commit isn't the one in known_good.json")
if(NOT TARGET SPIRV-Tools-opt) if(NOT TARGET SPIRV-Tools-opt)
if(ALLOW_EXTERNAL_SPIRV_TOOLS) if(ALLOW_EXTERNAL_SPIRV_TOOLS)
# Look for external SPIR-V Tools build, if not building in-tree # Look for external SPIR-V Tools build, if not building in-tree

View file

@ -264,6 +264,9 @@ Test](gtests/), one is the [`runtests` script](Test/runtests). The former
runs unit tests and single-shader single-threaded integration tests, while runs unit tests and single-shader single-threaded integration tests, while
the latter runs multiple-shader linking tests and multi-threaded tests. the latter runs multiple-shader linking tests and multi-threaded tests.
Tests may erroneously fail or pass if using `ALLOW_EXTERNAL_SPIRV_TOOLS` with
any commit other than the one specified in `known_good.json`.
### Running tests ### Running tests
The [`runtests` script](Test/runtests) requires compiled binaries to be The [`runtests` script](Test/runtests) requires compiled binaries to be