X-Git-Url: https://git.liburcu.org/?p=urcu.git;a=blobdiff_plain;f=README;h=8d0b18e73e691bf282e1ad0c345ee07dfbc9f6e8;hp=89708053007fe06c2bbd72825298e812a38ec553;hb=92af1a30ca6a70945b167c31631c8598a626c71a;hpb=9e6b9f8afa8e70854a4e09e326de45dbd7e63bef diff --git a/README b/README index 8970805..8d0b18e 100644 --- a/README +++ b/README @@ -101,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 @@ -304,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