From: Daniel Stenberg <daniel@haxx.se>
Date: Thu, 26 Oct 2023 12:03:47 +0000 (+0200)
Subject: CURLOPT_WRITEFUNCTION.3: clarify what libcurl returns for CURL_WRITEFUNC_ERROR
X-Git-Tag: curl-8_5_0~198
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=910f740ce29f881878e3029ac4a00150ca8b3d8c;p=thirdparty%2Fcurl.git

CURLOPT_WRITEFUNCTION.3: clarify what libcurl returns for CURL_WRITEFUNC_ERROR

It returns CURLE_WRITE_ERROR. It was not previously stated clearly.

Reported-by: enWILLYado on github
Fixes #12201
Closes #12203
---

diff --git a/docs/libcurl/opts/CURLOPT_WRITEFUNCTION.3 b/docs/libcurl/opts/CURLOPT_WRITEFUNCTION.3
index 083b008b47..138133ceaa 100644
--- a/docs/libcurl/opts/CURLOPT_WRITEFUNCTION.3
+++ b/docs/libcurl/opts/CURLOPT_WRITEFUNCTION.3
@@ -63,7 +63,8 @@ that amount differs from the amount passed to your callback function, it
 signals an error condition to the library. This causes the transfer to get
 aborted and the libcurl function used returns \fICURLE_WRITE_ERROR\fP.
 
-You can also abort the transfer by returning CURL_WRITEFUNC_ERROR. (7.87.0)
+You can also abort the transfer by returning CURL_WRITEFUNC_ERROR (added in
+7.87.0), which makes \fICURLE_WRITE_ERROR\fP get returned.
 
 If the callback function returns CURL_WRITEFUNC_PAUSE it pauses this
 transfer. See \fIcurl_easy_pause(3)\fP for further details.