Consolidate receiver/filter/writer {pre,post}_select() docs.

[paraslash.git] / filter_common.c

diff --git a/filter_common.c b/filter_common.c
index add788a8f30465251ff111822b7131cd2e94054b..4702df6cb85a1a10f951d31f8c9471cd63668307 100644 (file)
--- a/filter_common.c
+++ b/filter_common.c
@@ -169,15 +169,14 @@ void print_filter_list(void)
 }
 
 /**
- * Set select timeout of the scheduler.
+ * Request a minimal timeout if not idle.
  *
- * \param s The scheduler.
- * \param context Pointer to the filter node (task context).
+ * \param s The scheduler instance.
+ * \param context Pointer to the filter node.
  *
- * This looks at the status of the btr node of the filter. If data is available
- * in the input queue of the filter, or if an error occurred, a minimal timeout
- * for the next select call is requested from the scheduler. Otherwise the
- * scheduler timeout is left unchanged.
+ * If the buffer tree node of the given filter node has data available (or is
+ * in error state) a minimal I/O timeout is requested from the scheduler.
+ * Otherwise the function does nothing.
  */
 void generic_filter_pre_select(struct sched *s, void *context)
 {