addr: improve intro documentation

andikleen · Mar 29, 2014 · cf6ee66 · cf6ee66
1 parent 62d5d69
commit cf6ee66
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/addr/Makefile b/addr/Makefile
@@ -12,7 +12,7 @@ addr: ${OBJ}
 clean:
 	rm -f addr ${OBJ} addr.html addr.man
 
-DOCFILES := cpu.c perf.c
+DOCFILES := perf.c cpu.c
 
 html: addr.html
 

diff --git a/addr/perf.c b/addr/perf.c
@@ -18,7 +18,8 @@
  * DOC: A simple perf library to manage the perf ring buffer
  *
  * This library provides a simple wrapping layer for the perf 
- * mmap ring buffer.
+ * mmap ring buffer. This allows to access perf events in 
+ * zero-copy from a user program.
  */
 
 #include <linux/perf_event.h>