From: Andre Noll <maan@tuebingen.mpg.de>
Date: Sat, 17 Oct 2015 17:22:07 +0000 (+0200)
Subject: filter.h: Improve documentation of ->pre_select().
X-Git-Tag: v0.5.6~74
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=8c74f69967ee4d6dff3970735c8bc83ea1aae4cb;ds=sidebyside

filter.h: Improve documentation of ->pre_select().

Fix a grammar issue ("it only allowed") and explain the purpose of
the fd sets.
---

diff --git a/filter.h b/filter.h
index 135a6887..7ae28fe4 100644
--- a/filter.h
+++ b/filter.h
@@ -96,10 +96,12 @@ struct filter {
 	/**
 	 * Set scheduler timeout and add file descriptors to fd sets.
 	 *
-	 * This function is used to control the timeout value for select. It
-	 * only allowed to decrease the current value. The second purpose of
-	 * this function is to set file descriptors to be watched by the
-	 * subsequent select call to the two fd sets.
+	 * This function controls the timeout value for the next call to
+	 * select(2). It may decrease the current timeout but shall never
+	 * increase it. The second purpose of this function is to add file
+	 * descriptors to the two fd sets of the sched structure. The
+	 * descriptors in these sets will be watched by the subsequent
+	 * select(2) call.
 	 */
 	void (*pre_select)(struct sched *s, void *context);
 	/**