Better comments for bioWaitPendingJobsLE

diff --git a/src/bio.c b/src/bio.c
index 108140f7aca5ac36fe4338a6c07d00157d696c7c..882d4183b1e88d7f3111624fd52a5a2899ee2f83 100644 (file)
--- a/src/bio.c
+++ b/src/bio.c
@@ -140,7 +140,15 @@ unsigned long long bioPendingJobsOfType(int type) {
  * less or equal to the specified number.
  *
  * This function may block for long time, it should only be used to perform
  * less or equal to the specified number.
  *
  * This function may block for long time, it should only be used to perform

- * special tasks like AOF rewriting or alike. */
+ * the following tasks:
+ *
+ * 1) To avoid that the main thread is pushing jobs of a given time so fast
+ *    that the background thread can't process them at the same speed.
+ *    So before creating a new job of a given type the main thread should
+ *    call something like: bioWaitPendingJobsLE(job_type,10000);
+ * 2) In order to perform special operations that make it necessary to be sure
+ *    no one is touching shared resourced in the background.
+ */

 void bioWaitPendingJobsLE(int type, unsigned long long num) {
     unsigned long long iteration = 0;
 
 void bioWaitPendingJobsLE(int type, unsigned long long num) {
     unsigned long long iteration = 0;