diff options
| -rw-r--r-- | lib/System/README.txt | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/lib/System/README.txt b/lib/System/README.txt new file mode 100644 index 0000000000..258a48cd87 --- /dev/null +++ b/lib/System/README.txt @@ -0,0 +1,23 @@ +System Utilities Interface +========================== + +The design of this library has several key constraints aimed at shielding LLVM +from the vagaries of operating system differences. The goal here is to provide +interfaces to operating system concepts (files, memory maps, sockets, signals, +locking, etc) efficiently and in such a way that the remainder of LLVM is +completely operating system agnostic. + +PLEASE READ AND COMPREHEND FULLY THE DOCUMENTATION in + +llvm/docs/SystemLibrary.html + +before making changes to this library. + +Briefly, the rules are: + +1. This library may not expose no system-specific header files (STL excepted). +2. This library may not allocate memory (directly). +3. This library may not throw exceptions. +4. This library may not use virtual methods in its classes. +5. This library may not expose system specific types, data or functions through + its interface |