wangtao
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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.

llvm-svn: 14979
This commit is contained in:
Reid Spencer 2004-07-18 22:33:08 +00:00
parent e0050f06b0
commit 44a81c6bdd
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
llvm/lib/System/README.txt Normal file
View File

@ -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