From: Daniel Stenberg <daniel@haxx.se>
Date: Thu, 5 Sep 2024 14:17:50 +0000 (+0200)
Subject: CURLMOPT_SOCKETFUNCTION.md: expand on the easy argument
X-Git-Tag: curl-8_10_0~33
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=56f90637ada4200a615f3a9fd9584650ecfeb343;p=thirdparty%2Fcurl.git

CURLMOPT_SOCKETFUNCTION.md: expand on the easy argument

Since recent changes makes it more likely to be an internal handle that
shows up and some users have been surprised by this.

Ref: #14792
Closes #14795
---

diff --git a/docs/libcurl/opts/CURLMOPT_SOCKETFUNCTION.md b/docs/libcurl/opts/CURLMOPT_SOCKETFUNCTION.md
index a53ee43d30..60c1185ea3 100644
--- a/docs/libcurl/opts/CURLMOPT_SOCKETFUNCTION.md
+++ b/docs/libcurl/opts/CURLMOPT_SOCKETFUNCTION.md
@@ -50,6 +50,9 @@ libcurl by calling curl_multi_socket_action(3).
 # CALLBACK ARGUMENTS
 
 *easy* identifies the specific transfer for which this update is related.
+Since this callback manages a whole multi handle, an application should not
+make assumptions about which particular handle that is passed here. It might
+even be an internal easy handle that the application did not add itself.
 
 *s* is the specific socket this function invocation concerns. If the
 **what** argument is not CURL_POLL_REMOVE then it holds information about