Skip to contentSkip to conversation

relayfs: function docfix

PATCH New Tom Zanussi 1 participant 1 message Jun 22, 2005

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 relayfs: function docfix

This patch adds missing documentation to the subbuf_start() callback. Thanks to Mathieu Desnoyers for pointing it out.

Tom

include/linux/relayfs_fs.h +3 -0
diff -urpN -X dontdiff linux-2.6.12-mm1/include/linux/relayfs_fs.h linux-2.6.12-mm1-cur/include/linux/relayfs_fs.h
@@ -88,6 +88,9 @@ struct rchan_callbacks
 	 * @prev_subbuf_idx: the previous sub-buffer's index
 	 * @prev_subbuf: the start of the previous sub-buffer
 	 *
+	 * The client should return the number of bytes it reserves at
+	 * the beginning of the sub-buffer, 0 if none.
+	 *
 	 * NOTE: subbuf_start will also be invoked when the buffer is
 	 *       created, so that the first sub-buffer can be initialized
 	 *       if necessary.  In this case, prev_subbuf will be NULL.