[Spread-cvs] commit: r309 - in trunk/docs/flush: docs man

[jschultz at spread.org]

Author: jschultz
Date: 2006-02-20 20:38:43 -0500 (Mon, 20 Feb 2006)
New Revision: 309

Modified:
   trunk/docs/flush/docs/FL_receive.html
   trunk/docs/flush/man/FL_receive.3
Log:
Added changes to FL docs discussing the recently added offset fcns.



Modified: trunk/docs/flush/docs/FL_receive.html
===================================================================
--- trunk/docs/flush/docs/FL_receive.html	2006-02-21 01:29:23 UTC (rev 308)
+++ trunk/docs/flush/docs/FL_receive.html	2006-02-21 01:38:43 UTC (rev 309)
@@ -372,7 +372,10 @@
 
 <P>
 The vid and num_members parameters will already be endian corrected.
-The dgroups array will contain num_members group names.  The content
+The dgroups array will contain num_members group names.  The functions 
+FL_get_gid_offset_memb_mess(), FL_get_num_vs_offset_memb_mess() and 
+FL_get_vs_set_offset_memb_mess() provide the offsets to the associated 
+fields within the body of a membership message. The content
 of the dgroups array is dependent upon the type of the membership
 change:
 <DL COMPACT><DT><DD>
@@ -403,7 +406,7 @@
 a 
 <B>single</B>
 
-NETWORK change.
+NETWORK change.  
 </DL></DL>
 
 <P>

Modified: trunk/docs/flush/man/FL_receive.3
===================================================================
--- trunk/docs/flush/man/FL_receive.3	2006-02-21 01:29:23 UTC (rev 308)
+++ trunk/docs/flush/man/FL_receive.3	2006-02-21 01:38:43 UTC (rev 309)
@@ -276,9 +276,11 @@
 .RE
 
 The vid and num_members parameters will already be endian corrected.
-The dgroups array will contain num_members group names.  The content
-of the dgroups array is dependent upon the type of the membership
-change:
+The dgroups array will contain num_members group names.  The functions
+FL_get_gid_offset_memb_mess(), FL_get_num_vs_offset_memb_mess() and
+FL_get_vs_set_offset_memb_mess() provide the offsets to the associated
+fields within the body of a membership message. The content of the
+dgroups array is dependent upon the type of the membership change:
 .RS
 .TP 0.8i
 .B CAUSED_BY_JOIN: