Add deprecation for SPIRV/ install folder location.
authordan sinclair <dsinclair@google.com>
Wed, 6 Nov 2019 14:50:40 +0000 (09:50 -0500)
committerdan sinclair <dj2@everburning.com>
Wed, 6 Nov 2019 14:50:40 +0000 (09:50 -0500)
This Cl updates the README.md to reference the deprecation date for the
current SPIRV/ install location.

Issue #1964

README.md

index f5651e1d4bd389251cb783366141257ff60356ce..f1f6a2bb95de198a2662be0d7cd8be90e454020a 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -28,6 +28,15 @@ comment in `glslang/MachineIndependent/Versions.cpp`.
 
 Tasks waiting to be done are documented as GitHub issues.
 
+Deprecations
+------------
+
+1. GLSLang, when installed through CMake, will install a `SPIRV` folder into
+`${CMAKE_INSTALL_INCLUDEDIR}`. This `SPIRV` folder is being moved to
+`glslang/SPIRV`. During the transition the `SPIRV` folder will be installed into
+both locations. The old install of `SPIRV/` will be removed as a CMake install
+target no sooner then May 1, 2020. See issue #1964.
+
 Execution of Standalone Wrapper
 -------------------------------