aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorReid Spencer <rspencer@reidspencer.com>2004-07-17 08:39:53 +0000
committerReid Spencer <rspencer@reidspencer.com>2004-07-17 08:39:53 +0000
commit8b67f54767e29ccd98dd21ba3e0165931bc29924 (patch)
tree1710087ac25b738cf925b903d29590767c7c2f93
parentcb19d679076724a86b62a1821e422ad69ab3d9c5 (diff)
downloadexternal_llvm-8b67f54767e29ccd98dd21ba3e0165931bc29924.zip
external_llvm-8b67f54767e29ccd98dd21ba3e0165931bc29924.tar.gz
external_llvm-8b67f54767e29ccd98dd21ba3e0165931bc29924.tar.bz2
Added a README to point users to the documentation on the design of this
library which is a prerequisite for maintaining the library. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@14909 91177308-0d34-0410-b5e6-96231b3b80d8
-rw-r--r--include/llvm/System/README.txt14
1 files changed, 14 insertions, 0 deletions
diff --git a/include/llvm/System/README.txt b/include/llvm/System/README.txt
new file mode 100644
index 0000000..1c4860e
--- /dev/null
+++ b/include/llvm/System/README.txt
@@ -0,0 +1,14 @@
+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.