summaryrefslogtreecommitdiff
path: root/source3/lib/pthreadpool/pthreadpool.h
diff options
context:
space:
mode:
Diffstat (limited to 'source3/lib/pthreadpool/pthreadpool.h')
-rw-r--r--source3/lib/pthreadpool/pthreadpool.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/source3/lib/pthreadpool/pthreadpool.h b/source3/lib/pthreadpool/pthreadpool.h
index 255393377f..79704ea385 100644
--- a/source3/lib/pthreadpool/pthreadpool.h
+++ b/source3/lib/pthreadpool/pthreadpool.h
@@ -39,6 +39,9 @@ struct pthreadpool;
* @param[in] max_threads Maximum parallelism in this pool
* @param[out] presult Pointer to the threadpool returned
* @return success: 0, failure: errno
+ *
+ * max_threads=0 means unlimited parallelism. The caller has to take
+ * care to not overload the system.
*/
int pthreadpool_init(unsigned max_threads, struct pthreadpool **presult);