bufopen: better description of the offset parameter.
authorNicolas Pennequin <nicolas.pennequin@free.fr>
Tue, 14 Aug 2007 18:58:58 +0000 (14 20:58 +0200)
committerNicolas Pennequin <nicolas.pennequin@free.fr>
Tue, 14 Aug 2007 18:58:58 +0000 (14 20:58 +0200)
testplugin.c

index ab6168c..3e2df0f 100644 (file)
@@ -515,7 +515,8 @@ management functions for all the actual handle management work.
 
 /* Request a file be buffered
    filename: name of the file to open
-   offset:starting offset to buffer from the file
+   offset: offset at which to start buffering the file, useful when the first
+           (offset-1) bytes of the file aren't needed.
    return value: <0 if the file cannot be opened, or one file already
    queued to be opened, otherwise the handle for the file in the buffer
 */