[TSan] Add a comment that tsan_flags.h may be included in the user code, and therefore shouldn't include other headers from TSan or common sanitizer runtime. User may need tsan_flags.h to provide its implementation of __tsan::OverrideFlags

llvm-svn: 158708
This commit is contained in:
Alexey Samsonov 2012-06-19 08:57:53 +00:00
parent af70c09b84
commit b1c3991915
1 changed files with 7 additions and 1 deletions

View File

@ -8,12 +8,18 @@
//===----------------------------------------------------------------------===// //===----------------------------------------------------------------------===//
// //
// This file is a part of ThreadSanitizer (TSan), a race detector. // This file is a part of ThreadSanitizer (TSan), a race detector.
// // NOTE: This file may be included into user code.
//===----------------------------------------------------------------------===// //===----------------------------------------------------------------------===//
#ifndef TSAN_FLAGS_H #ifndef TSAN_FLAGS_H
#define TSAN_FLAGS_H #define TSAN_FLAGS_H
// ----------- ATTENTION -------------
// ThreadSanitizer user may provide its implementation of weak
// symbol __tsan::OverrideFlags(__tsan::Flags). Therefore, this
// header may be included in the user code, and shouldn't include
// other headers from TSan or common sanitizer runtime.
namespace __tsan { namespace __tsan {
struct Flags { struct Flags {