[PATCH] Improve documentation for SMstore and SMretrieve

Ian Jackson ijackson at chiark.greenend.org.uk
Sat May 22 23:19:53 UTC 2010

ARTHANDLE contains two different ways of representing article data: an
iovec array, and a char*/length pair.  One is used by SMstore and the
other by SMretrieve, but this is not documented.

This is corrected by this patch.


diff --git a/doc/man/libstorage.3 b/doc/man/libstorage.3
index c6f2cfd..e4e2bb0 100644
--- a/doc/man/libstorage.3
+++ b/doc/man/libstorage.3
@@ -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
+.I iov
+.IR iovcnt ;
+.I data
+.I private
+are ignored by
+.IR SMstore .
 .I arrived
 is specified,
@@ -189,7 +200,16 @@ RETR_STAT	just check to see if article exists
 .in -0.5i
 .sp 1
+.I SMretrieve
+provides the article data via the
+.I data
+.I len
+members of
+.I iov
+is not set by
+.IR SMretrieve .
 The data area indicated by
 should not be modified.

More information about the inn-workers mailing list