From: Tim Sutherland <timsuth@...>
Date: 2004-10-30T12:08:22+09:00
Subject: [PATCH] dl.txt explaining PtrData#ptr,ref

I posted this patch last night under ruby-talk:118202.

The documentation for PtrData#ptr and PtrData#ref is a bit unclear.
We should say that they are like `*ptr' and `&ptr' respectively.

(This is the first time I have submitted a patch for Ruby. Please tell
me if this is the wrong place for it, or if the patch format is
incorrect. BTW: dl is a wonderful wonderful library.)


Index: dl.txt
===================================================================
RCS file: /src/ruby/ext/dl/doc/dl.txt,v
retrieving revision 1.9
diff -u -r1.9 dl.txt
--- dl.txt	11 Jan 2003 17:28:59 -0000	1.9
+++ dl.txt	30 Oct 2004 03:05:02 -0000
@@ -198,10 +198,12 @@
     string is '\0'.
 
 * ptr = PtrData#ptr,+@
-  * returns the pointed value as a PtrData object ptr.
+  * returns the dereferenced value as a PtrData object ptr.
+    this is like `*ptr' in C.
 
 * ptr = PtrData#ref,-@
   * returns the reference as a PtrData object ptr.
+    this is like `&ptr' in C.
 
 * ptr = PtrData#+
   * returns the PtrData object