]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
curl_multi_socket_all.md: soften the deprecation warning
authorJay Satiro <raysatiro@yahoo.com>
Wed, 13 Nov 2024 21:17:37 +0000 (16:17 -0500)
committerJay Satiro <raysatiro@yahoo.com>
Mon, 18 Nov 2024 19:17:14 +0000 (14:17 -0500)
- Instead of saying "do not use", explain that the function was
  deprecated for performance reasons.

Some users may have a legitimate use of this function even though we
deprecated it. Since there are no plans to remove it from the API get
rid of the "do not use" warning.

Bug: https://curl.se/mail/lib-2024-11/0029.html
Reported-by: Jacob Champion
Closes https://github.com/curl/curl/pull/15576

docs/libcurl/curl_multi_socket.md
docs/libcurl/curl_multi_socket_all.md

index 5903a1e1fa8de4ee3af4e0b5ed45b96d53b8822b..490af19c4f356d5e49a2e221e8878c84fbd5146d 100644 (file)
@@ -29,8 +29,8 @@ CURLMcode curl_multi_socket(CURLM *multi_handle, curl_socket_t sockfd,
 
 # DESCRIPTION
 
-This function is deprecated. Do not use. See curl_multi_socket_action(3)
-instead.
+This function is deprecated. Use curl_multi_socket_action(3) instead with
+**ev_bitmask** set to 0.
 
 At return, the integer **running_handles** points to contains the number of
 still running easy handles within the multi handle. When this number reaches
@@ -54,9 +54,6 @@ to CURL_SOCKET_TIMEOUT. You can also use the curl_multi_timeout(3) function to
 poll the value at any given time, but for an event-based system using the
 callback is far better than relying on polling the timeout value.
 
-Usage of curl_multi_socket(3) is deprecated, whereas the function is
-equivalent to curl_multi_socket_action(3) with **ev_bitmask** set to 0.
-
 # %PROTOCOLS%
 
 # EXAMPLE
index 37a605bde3bdfff5cf9203e89a4bad4e18564c4d..d7f832b51dfa3e26fe3fc2b29ef4966074771ea4 100644 (file)
@@ -30,8 +30,8 @@ CURLMcode curl_multi_socket_all(CURLM *multi_handle,
 
 # DESCRIPTION
 
-This function is deprecated. Do not use. See curl_multi_socket_action(3)
-instead.
+This function is deprecated for performance reasons but there are no plans to
+remove it from the API. Use curl_multi_socket_action(3) instead.
 
 At return, the integer **running_handles** points to contains the number of
 still running easy handles within the multi handle. When this number reaches