From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Sat, 26 Jan 2013 15:51:31 +0000 (-0500)
Subject: README: document each API file
X-Git-Tag: v0.8.0~114
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=9b4ec2a5057c31c606d3f3554794eb4957909bde;p=urcu.git

README: document each API file

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

diff --git a/README b/README
index 9554d21..e676757 100644
--- a/README
+++ b/README
@@ -73,11 +73,11 @@ API
 See the relevant API documentation files in doc/. The APIs provided by
 Userspace RCU are, by prefix:
 
-- rcu_ : Read-Copy Update
+- rcu_ : Read-Copy Update (see doc/rcu-api.txt)
 - cmm_ : Concurrent Memory Model
 - caa_ : Concurrent Architecture Abstraction
-- cds_ : Concurrent Data Structures
-- uatomic_: Userspace Atomic
+- cds_ : Concurrent Data Structures (see doc/cds-api.txt)
+- uatomic_: Userspace Atomic (see doc/uatomic-api.txt)
 
 
 QUICK START GUIDE