summaryrefslogtreecommitdiffstats
path: root/src/concurrent
diff options
context:
space:
mode:
authorDennis Oberst <dennis.oberst@qt.io>2023-06-14 18:31:40 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2023-06-26 07:59:15 +0000
commit69fa86f81d28a91008f911b13d00cd654505a314 (patch)
tree748aef5e3fc9a0f3dbb99527a3e8d4ce737bab5e /src/concurrent
parent604d25e2387f886e4fce59dd00eab141a880c7b9 (diff)
QFuture: mention the work-stealing algorithm in the docs
A number of users have explored the behavior and complained about it. Lets add a \note explaining this. The function in charge is QThreadPool::stealAndRunRunnable(QRunnable *), which is a private function, exclusively used by: QFutureInterfaceBase::waitForResult() QFutureInterfaceBase::waitForFinished() also update the documentation to reflect these changes accordingly. Fixes: QTBUG-112351 Change-Id: I839858cb449063d8af9bef64d2f35a6816a419b0 Reviewed-by: Ivan Solovev <ivan.solovev@qt.io> Reviewed-by: MÃ¥rten Nordheim <marten.nordheim@qt.io> (cherry picked from commit 0235de994be7e04aca3456f1260b18313dd45b74) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'src/concurrent')
-rw-r--r--src/concurrent/qtconcurrentrun.cpp5
1 files changed, 2 insertions, 3 deletions
diff --git a/src/concurrent/qtconcurrentrun.cpp b/src/concurrent/qtconcurrentrun.cpp
index fc19b947e5..9a7fe2167a 100644
--- a/src/concurrent/qtconcurrentrun.cpp
+++ b/src/concurrent/qtconcurrentrun.cpp
@@ -259,9 +259,8 @@
\since 5.4
\fn QFuture<T> QtConcurrent::run(QThreadPool *pool, Function function, ...);
- Runs \a function in a separate thread. The thread is taken from the
- QThreadPool \a pool. Note that \a function may not run immediately; \a function
- will only be run once a thread becomes available.
+ Schedules \a function on \a pool. Note that \a function may not run
+ immediately; \a function will only be run once a thread becomes available.
\include qtconcurrentrun.cpp run-description
*/