From 8b67f54767e29ccd98dd21ba3e0165931bc29924 Mon Sep 17 00:00:00 2001 From: Reid Spencer Date: Sat, 17 Jul 2004 08:39:53 +0000 Subject: [PATCH] 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 --- include/llvm/System/README.txt | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 include/llvm/System/README.txt diff --git a/include/llvm/System/README.txt b/include/llvm/System/README.txt new file mode 100644 index 00000000000..1c4860ea8af --- /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.