From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Fri, 12 Oct 2012 11:47:11 +0000 (-0400)
Subject: Document APIs in README
X-Git-Tag: v0.8.0~193
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=207e8061ddfafbdd0502fb6da4896b4c40a49253;p=userspace-rcu.git

Document APIs in README

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

diff --git a/README b/README
index 303c6ec..81afe0e 100644
--- a/README
+++ b/README
@@ -22,6 +22,7 @@ BUILDING
 		Forcing a 32-bit build for Sparcv9 (typical for Sparc v9)
 		* CFLAGS="-m32 -Wa,-Av9a -g -O2" ./configure
 
+
 ARCHITECTURES SUPPORTED
 -----------------------
 
@@ -66,6 +67,19 @@ Test scripts provided in the tests/ directory of the source tree depend
 on "bash" and the "seq" program.
 
 
+API
+---
+
+See the relevant API documentation files in doc/. The APIs provided by
+Userspace RCU are, by prefix:
+
+- rcu_ : Read-Copy Update
+- cmm_ : Concurrent Memory Model
+- caa_ : Concurrent Architecture Abstraction
+- cds_ : Concurrent Data Structures
+- uatomic_: Userspace Atomic
+
+
 QUICK START GUIDE
 -----------------