aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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 0000000000..1c4860ea8a
--- /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.