Add lttng-dev mailing list to readme

[urcu.git] / README

diff --git a/README b/README
index c7403f8da1ca35e8d9734d74ed47e5fdabf3f7fd..8d0b18e73e691bf282e1ad0c345ee07dfbc9f6e8 100644 (file)
--- a/README
+++ b/README
@@ -51,6 +51,13 @@ supported, with the following exceptions:
 
 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
@@ -94,6 +101,19 @@ Usage of all urcu libraries
          instead of inlines, so your application can link with the library.
        * Linking with one of the libraries below is always necessary even for
          LGPL and GPL applications.
+       * Define URCU_INLINE_SMALL_FUNCTIONS before including Userspace RCU
+         headers if you want Userspace RCU to inline small functions (10
+         lines or less) into the application. It can be used by applications
+         distributed under any kind of license, and does *not* make the
+         application a derived work of Userspace RCU.
+
+         Those small inlined functions are guaranteed to match the library
+         content as long as the library major version is unchanged.
+         Therefore, the application *must* be compiled with headers matching
+         the library major version number. Applications using
+         URCU_INLINE_SMALL_FUNCTIONS may be unable to use debugging
+         features of Userspace RCU without being recompiled.
+
 
 Usage of liburcu
 
@@ -297,3 +317,24 @@ SMP support
                ./configure --disable-smp-support
 
        theoretically yielding slightly better performance.
+
+MAKE TARGETS
+------------
+
+In addition to the usual "make check" target, Userspace RCU features
+"make regtest" and "make bench" targets.
+
+make check:   Short tests, meant to be run when rebuilding or porting
+              Userspace RCU.
+
+make regtest: Long (many hours) test, meant to be run when modifying
+              Userspace RCU or porting it to a new architecture or
+              operating system.
+
+make bench:   Long (many hours) benchmarks.
+
+CONTACTS
+--------
+
+You can contact the maintainers on the following mailing list:
+lttng-dev@lists.lttng.org