[svn:parrot] r41171 - trunk/src/ops

[duff at svn.parrot.org]

Author: duff
Date: Wed Sep  9 05:46:53 2009
New Revision: 41171
URL: https://trac.parrot.org/parrot/changeset/41171

Log:
Document a guess about the valid values for the whence parameter to seek()

Modified:
   trunk/src/ops/io.ops

Modified: trunk/src/ops/io.ops
==============================================================================
--- trunk/src/ops/io.ops	Wed Sep  9 04:25:57 2009	(r41170)
+++ trunk/src/ops/io.ops	Wed Sep  9 05:46:53 2009	(r41171)
@@ -445,7 +445,15 @@
 
 seek:
 Set file position to offset $2 on IO stream $1. 'whence' is
-indicated by the value in $3.
+indicated by the value in $3. The valid values for 'whence' are:
+
+ Value      Meaning
+ 0          Seek from the beginning of the file
+ 1          Seek from the current position
+ 2          Seek from the end of the file
+
+[ Note: the above values for 'whence' is just an educated guess
+at this point ]
 
 =item B<seek>(invar PMC, in INT, in INT, in INT)