From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Fri, 9 Aug 2013 22:19:08 +0000 (-0400)
Subject: README: document make check/regtest/bench
X-Git-Tag: v0.8.0~5
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=aea3bcbcd4fb8bb79fa77724b1be7dc088b650a2;p=userspace-rcu.git

README: document make check/regtest/bench

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
---

diff --git a/README b/README
index 8970805..218b4be 100644
--- a/README
+++ b/README
@@ -304,3 +304,18 @@ 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.