From 91de5421b250874cfff7554ae48cdb7dbc757789 Mon Sep 17 00:00:00 2001
From: antirez <antirez@gmail.com>
Date: Wed, 14 Sep 2011 19:05:21 +0200
Subject: [PATCH] Better comments for bioWaitPendingJobsLE
---
src/bio.c | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/src/bio.c b/src/bio.c
index 108140f7..882d4183 100644
--- 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
- * 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;