X-Git-Url: https://git.liburcu.org/?p=urcu.git;a=blobdiff_plain;f=README;h=89708053007fe06c2bbd72825298e812a38ec553;hp=9554d2141875289a8e1ef3fb7b1df9a7f5145ba3;hb=f5ab766ee2c8300cb00ca5878b1cb464f960a66d;hpb=74093738f199e3109f1d4ef0ce87b434ddc03e3f diff --git a/README b/README index 9554d21..8970805 100644 --- a/README +++ b/README @@ -27,9 +27,10 @@ ARCHITECTURES SUPPORTED ----------------------- Currently, Linux x86 (i386, i486, i586, i686), x86 64-bit, PowerPC 32/64, -S390, S390x, ARM, Alpha, ia64 and Sparcv9 32/64 are supported. Tested on -Linux, FreeBSD 8.2/9.0, and Cygwin. Should also work on: Android, NetBSD 5, -OpenBSD, Darwin (more testing needed before claiming support for these OS). +S390, S390x, ARM, MIPS, Alpha, ia64 and Sparcv9 32/64 are supported. +Tested on Linux, FreeBSD 8.2/8.3/9.0/9.1/10.0 i386/amd64, and Cygwin. +Should also work on: Android, NetBSD 5, OpenBSD, Darwin (more testing +needed before claiming support for these OS). Linux ARM depends on running a Linux kernel 2.6.15 or better, GCC 4.4 or better. @@ -48,6 +49,15 @@ supported, with the following exceptions: support. For ARM this was introduced with gcc 4.4: http://gcc.gnu.org/gcc-4.4/changes.html +Clang version 3.0 (based on LLVM 3.0) is supported. + +Building on MacOS X (Darwin) requires a work-around for processor +detection: + # 32-bit + ./configure --build=i686-apple-darwin11 + # 64-bit + ./configure --build=x86_64-apple-darwin11 + For developers using the git tree: This source tree is based on the autotools suite from GNU to simplify @@ -73,11 +83,11 @@ API See the relevant API documentation files in doc/. The APIs provided by Userspace RCU are, by prefix: -- rcu_ : Read-Copy Update +- rcu_ : Read-Copy Update (see doc/rcu-api.txt) - cmm_ : Concurrent Memory Model - caa_ : Concurrent Architecture Abstraction -- cds_ : Concurrent Data Structures -- uatomic_: Userspace Atomic +- cds_ : Concurrent Data Structures (see doc/cds-api.txt) +- uatomic_: Userspace Atomic (see doc/uatomic-api.txt) QUICK START GUIDE