System/Synchronization.hpp: Add file documentation and warning.
Bug: b/133135427
Change-Id: Iadb691c7b0b957a494b57a8a5046a58a6b42180c
Reviewed-on: https://swiftshader-review.googlesource.com/c/SwiftShader/+/31809
Tested-by: Ben Clayton <bclayton@google.com>
Reviewed-by: Chris Forbes <chrisforbes@google.com>
Reviewed-by: Alexis Hétu <sugoi@google.com>
Kokoro-Presubmit: kokoro <noreply+kokoro@google.com>
diff --git a/src/System/Synchronization.hpp b/src/System/Synchronization.hpp
index 7988a59..c3c8010 100644
--- a/src/System/Synchronization.hpp
+++ b/src/System/Synchronization.hpp
@@ -12,6 +12,13 @@
// See the License for the specific language governing permissions and
// limitations under the License.
+// This file contains a number of synchronization primitives for concurrency.
+//
+// You may be tempted to change this code to unlock the mutex before calling
+// std::condition_variable::notify_[one,all]. Please read
+// https://issuetracker.google.com/issues/133135427 before making this sort of
+// change.
+
#ifndef sw_Synchronization_hpp
#define sw_Synchronization_hpp
