Add notes about how to keep in sync runtime with LLVM project

3 files changed, 15 insertions, 0 deletions

diff --git a/runtime/Sanitizer/sanitizer_common/sanitizer_common.h b/runtime/Sanitizer/sanitizer_common/sanitizer_common.h
index ebb88600..7c1161f7 100644
--- a/runtime/Sanitizer/sanitizer_common/sanitizer_common.h
+++ b/runtime/Sanitizer/sanitizer_common/sanitizer_common.h
@@ -12,6 +12,12 @@
 // Implementation of some functions are provided in sanitizer_common, while
 // others must be defined by run-time library itself.
 //===----------------------------------------------------------------------===//
+
+// NOTE: Needs to be kept in sync with
+// compiler-rt/lib/sanitizer_common/sanitizer_common.h from LLVM project.
+// But in fact, nothing was used form that header, so leave it as a wrapper for
+// used internal headers.
+
 #ifndef SANITIZER_COMMON_H
 #define SANITIZER_COMMON_H
 
diff --git a/runtime/Sanitizer/sanitizer_common/sanitizer_internal_defs.h b/runtime/Sanitizer/sanitizer_common/sanitizer_internal_defs.h
index d0817abe..a8ba685a 100644
--- a/runtime/Sanitizer/sanitizer_common/sanitizer_internal_defs.h
+++ b/runtime/Sanitizer/sanitizer_common/sanitizer_internal_defs.h
@@ -9,6 +9,11 @@
 // This file is shared between AddressSanitizer and ThreadSanitizer.
 // It contains macro used in run-time libraries code.
 //===----------------------------------------------------------------------===//
+
+// NOTE: Needs to be kept in sync with
+// compiler-rt/lib/sanitizer_common/sanitizer_internal_defs.h from LLVM project.
+// But in fact, only typedefs for basic types were used, this is how it is.
+
 #ifndef SANITIZER_DEFS_H
 #define SANITIZER_DEFS_H
 
diff --git a/runtime/Sanitizer/sanitizer_common/sanitizer_platform.h b/runtime/Sanitizer/sanitizer_common/sanitizer_platform.h
index 074d2b74..d912a0f0 100644
--- a/runtime/Sanitizer/sanitizer_common/sanitizer_platform.h
+++ b/runtime/Sanitizer/sanitizer_common/sanitizer_platform.h
@@ -9,6 +9,10 @@
 // Common platform macros.
 //===----------------------------------------------------------------------===//
 
+// NOTE: Needs to be kept in sync with
+// compiler-rt/lib/sanitizer_common/sanitizer_platform.h from LLVM project.
+// But in fact, only SANITIZER_WORDSIZE macro was used, so how it is.
+
 #ifndef SANITIZER_PLATFORM_H
 #define SANITIZER_PLATFORM_H