Deprecate QtFuture::makeReadyFuture()

[ChangeLog][Deprecation Notice][QtCore] The QtFuture::makeReadyFuture()
method and all its specializations are deprecated since Qt 6.10.
The reason for the deprecation is that the method has a
makeReadyFuture(const QList<T> &) overload, which behaves differently
from all other overloads (including other non-const ref QList
overloads).
Use QtFuture::makeReadyVoidFuture() when you need a ready void QFuture,
or QtFuture::makeReadyValueFuture() when you need to propagate the
input type to the returned QFuture, or QtFuture::makeReadyRangeFuture()
when you need to create a multi-value future based on an input
container.

Fixes: QTBUG-109677
Change-Id: I55125269989df0a02840d5ddd5763ef5f1070df5
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Marc Mutz <marc.mutz@qt.io>

1 files changed, 18 insertions, 0 deletions

diff --git a/src/corelib/thread/qfuture.qdoc b/src/corelib/thread/qfuture.qdoc
index e9aabdda2d..7d0f639417 100644
--- a/src/corelib/thread/qfuture.qdoc
+++ b/src/corelib/thread/qfuture.qdoc
@@ -973,6 +973,12 @@
 
     \since 6.1
     \overload
+    \deprecated [6.10] Use makeReadyValueFuture() instead
+
+    The QtFuture::makeReadyFuture() method should be avoided because it has an
+    inconsistent set of overloads. It will be deprecated in future Qt releases.
+    Use QtFuture::makeReadyVoidFuture(), QtFuture::makeReadyValueFuture() or
+    QtFuture::makeReadyRangeFuture() instead.
 
     Creates and returns a QFuture which already has a result \a value.
     The returned QFuture has a type of std::decay_t<T>, where T is not void.
@@ -992,6 +998,12 @@
 
     \since 6.1
     \overload
+    \deprecated [6.10] Use makeReadyVoidFuture() instead
+
+    The QtFuture::makeReadyFuture() method should be avoided because it has an
+    inconsistent set of overloads. It will be deprecated in future Qt releases.
+    Use QtFuture::makeReadyVoidFuture(), QtFuture::makeReadyValueFuture() or
+    QtFuture::makeReadyRangeFuture() instead.
 
     Creates and returns a void QFuture. Such QFuture can't store any result.
     One can use it to query the state of the computation.
@@ -1015,6 +1027,12 @@
 
     \since 6.1
     \overload
+    \deprecated [6.10] Use makeReadyRangeFuture() instead
+
+    The QtFuture::makeReadyFuture() method should be avoided because it has an
+    inconsistent set of overloads. It will be deprecated in future Qt releases.
+    Use QtFuture::makeReadyVoidFuture(), QtFuture::makeReadyValueFuture() or
+    QtFuture::makeReadyRangeFuture() instead.
 
     Creates and returns a QFuture which already has multiple results set from \a values.