chiark / gitweb /
Turn SMstore thing into notes in manpage inn.feature.storageh
authorIan Jackson <ian@liberator.relativity.greenend.org.uk>
Sat, 22 May 2010 12:18:04 +0000 (13:18 +0100)
committerIan Jackson <ian@liberator.relativity.greenend.org.uk>
Sat, 22 May 2010 12:18:04 +0000 (13:18 +0100)
doc/man/libstorage.3
include/storage.h

index c6f2cfd..e4e2bb0 100644 (file)
@@ -151,6 +151,17 @@ returns true, unless all storage methods fail initialization.
 .I SMstore
 stores an article specified with
 .IR article .
+The headers and body of the article are supplied to
+.I SMstore
+using
+.I iov
+and
+.IR iovcnt ;
+.I data
+and
+.I private
+are ignored by
+.IR SMstore .
 If
 .I arrived
 is specified,
@@ -189,7 +200,16 @@ RETR_STAT  just check to see if article exists
 .fi
 .in -0.5i
 .sp 1
-.PP
+.I SMretrieve
+provides the article data via the
+.I data
+and
+.I len
+members of
+.IR ARTHANDLE .
+.I iov
+is not set by
+.IR SMretrieve .
 The data area indicated by
 .I ARTHANDLE
 should not be modified.
index 4568b2a..9612a28 100644 (file)
@@ -48,9 +48,6 @@ typedef struct {
   int            groupslen;  /* Length of Newsgroups header */
   TOKEN          *token;     /* A pointer to the article's TOKEN */
 } ARTHANDLE;
- /* SMstore uses     iov*   but not data,len
-  * SMretrieve sets  type data,len private
-  */
 
 #define SMERR_NOERROR          0
 #define SMERR_INTERNAL         1