romenskiy2012/curl
1
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2026-04-14 22:31:41 +03:00
Code Issues Projects Releases Packages Wiki Activity

docs: avoid using the word 'magic'

Browse source 
It's never actually magic.

Closes #20796
This commit is contained in:
Daniel Stenberg 2026-03-03 13:53:36 +01:00
parent b4dba346cd
commit cc85cdf3c5
No known key found for this signature in database
GPG key ID: 5CC908FDB71E12C2
9 changed files with 20 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/libcurl/curl_easy_pause.md
View file

@ -32,11 +32,10 @@ most other libcurl functions, curl_easy_pause(3) can be used from within
callbacks.
A connection can be paused by using this function or by letting the read or
the write callbacks return the proper magic return code
(*CURL_READFUNC_PAUSE* and *CURL_WRITEFUNC_PAUSE*). A write callback
that returns pause signals to the library that it could not take care of any
data at all, and that data is then delivered again to the callback when the
transfer is unpaused.
the write callbacks return the proper return code (*CURL_READFUNC_PAUSE* and
*CURL_WRITEFUNC_PAUSE*). A write callback that returns pause signals to the
library that it could not take care of any data at all, and that data is then
delivered again to the callback when the transfer is unpaused.
While it may feel tempting, take care and notice that you cannot call this
function from another thread. To unpause, you may for example call it from the
@ -115,8 +114,8 @@ int main(void)
# MEMORY USE
When pausing a download transfer by returning the magic return code from a
write callback, the read data is already in libcurl's internal buffers so it
When pausing a download transfer by returning the appropriate return code from
a write callback, the read data is already in libcurl's internal buffers so it
has to keep it in an allocated buffer until the receiving is again unpaused
using this function.