Fix c99 compatibility: use __asm__ and __volatile__ in public headers

[urcu.git] / README

diff --git a/README b/README
index ce25e3a3dabc8977f7a4dc5d4e391e5238e455fc..33038af3ab12c0cc96aacbedf3cf6e76ea2fd5f7 100644 (file)
--- a/README
+++ b/README
@@ -25,11 +25,13 @@ BUILDING
 ARCHITECTURES SUPPORTED
 -----------------------
 
-Currently, x86 (i386, i486, i586, i686), x86 64-bit, PowerPC 32/64, S390, S390x,
-ARM, Alpha, ia64 and Sparcv9 32/64 are supported. Only tested on Linux so
-far, but should theoretically work on other operating systems.
+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).
 
-ARM depends on running a Linux kernel 2.6.15 or better.
+Linux ARM depends on running a Linux kernel 2.6.15 or better, GCC 4.4 or
+better.
 
 The gcc compiler versions 3.3, 3.4, 4.0, 4.1, 4.2, 4.3, 4.4 and 4.5 are
 supported, with the following exceptions:
@@ -41,8 +43,9 @@ supported, with the following exceptions:
     http://www.mail-archive.com/gcc-bugs@gcc.gnu.org/msg281255.html
 - gcc 3.3 cannot match the "xchg" instruction on 32-bit x86 build.
   See: http://kerneltrap.org/node/7507
-- Alpha, ia64 and ARM architectures depend on 4.x gcc with atomic builtins
-  support.
+- Alpha, ia64 and ARM architectures depend on gcc 4.x with atomic builtins
+  support. For ARM this was introduced with gcc 4.4:
+    http://gcc.gnu.org/gcc-4.4/changes.html
 
 For developers using the git tree:
 
@@ -59,6 +62,9 @@ If you get the tree from the repository, you will need to use the "bootstrap"
 script in the root of the tree. It calls all the GNU tools needed to prepare the
 tree configuration.
 
+Test scripts provided in the tests/ directory of the source tree depend
+on "bash" and the "seq" program.
+
 
 QUICK START GUIDE
 -----------------
@@ -171,7 +177,7 @@ Usage of urcu-call-rcu
          grace periods.  A number of additional functions are provided
          to manage the helper threads used by call_rcu(), but reasonable
          defaults are used if these additional functions are not invoked.
-         See API.txt for more details.
+         See rcu-api.txt in userspace-rcu documentation for more details.
 
 Being careful with signals