[llvm-commits] CVS: llvm/lib/System/README.txt

[LLVM]

Changes in directory llvm/lib/System:

README.txt added (r1.1)

---
Log message:

A description of what this library is about, reference to the documentation
and a list of don'ts for the library. All so future maintainers don't
break the important contract this library has with its user: LLVM.


---
Diffs of the changes:  (+23 -0)

Index: llvm/lib/System/README.txt
diff -c /dev/null llvm/lib/System/README.txt:1.1
*** /dev/null	Sun Jul 18 17:33:18 2004
--- llvm/lib/System/README.txt	Sun Jul 18 17:33:08 2004
***************
*** 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