docs: avoid using the word 'magic'

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

View File

@ -107,10 +107,10 @@ it out of an ambition to keep curl and libcurl excellent products and out of
pride.
Please do not assume that you can lump over something to us and it then
magically gets fixed after some given time. Most often we need feedback and
help to understand what you have experienced and how to repeat a problem. Then
we may only be able to assist YOU to debug the problem and to track down the
proper fix.
automatically gets fixed after some given time. Most often we need feedback
and help to understand what you have experienced and how to repeat a problem.
Then we may only be able to assist YOU to debug the problem and to track down
the proper fix.
We get reports from many people every month and each report can take a
considerable amount of time to really go to the bottom with.

View File

@ -101,8 +101,8 @@ well at the side. curl's output can be piped into another program or
redirected to another file for the next program to interpret.
We focus on protocol related issues and improvements. If you want to do more
magic with the supported protocols than curl currently does, chances are good
we will agree. If you want to add more protocols, we may agree.
with the supported protocols than curl currently does, chances are good we
will agree. If you want to add more protocols, we may agree.
If you want someone else to do all the work while you wait for us to implement
it for you, that is not a friendly attitude. We spend a considerable time
@ -487,7 +487,7 @@ individuals have ever tried.
## Does curl support JavaScript or PAC (automated proxy config)?
Many webpages do magic stuff using embedded JavaScript. curl and libcurl have
Many webpages do stuff using embedded JavaScript. curl and libcurl have
no built-in support for that, so it is treated like any other contents.
`.pac` files are a Netscape invention and are sometimes used by organizations

View File

@ -932,7 +932,7 @@ When compiling curl on OpenBSD with `--enable-debug` it gives linking errors
when you use GNU libtool. This can be fixed by using the libtool provided by
OpenBSD itself. However for this the user always needs to invoke make with
`LIBTOOL=/usr/bin/libtool`. It would be nice if the script could have some
magic to detect if this system is an OpenBSD host and then use the OpenBSD
logic to detect if this system is an OpenBSD host and then use the OpenBSD
libtool instead.
See [curl issue 5862](https://github.com/curl/curl/issues/5862)

View File

@ -10,7 +10,7 @@
output from the set of sources files in this directory.
The `mainpage.idx` file lists all files that are rendered in that order to
produce the output. The magic `%options` keyword inserts all command line
produce the output. The special `%options` keyword inserts all command line
options documented.
The `%options` documentation is created with one source file for each

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.

View File

@ -299,7 +299,7 @@ participate in. There are too many ways to do it and there is no knob we can
use to turn off the practice.
If you use curl or libcurl on Windows (any version), disable the use of the
FILE protocol in curl or be prepared that accesses to a range of "magic paths"
FILE protocol in curl or be prepared that accesses to a set of special paths
potentially make your system access other hosts on your network. curl cannot
protect you against this.

View File

@ -82,8 +82,8 @@ builds a linked list. See curl_slist_append(3)
## Sharing data between transfers
You can have multiple easy handles share certain data, even if they are used
in different threads. This magic is setup using the share interface, as
described in the libcurl-share(3) man page.
in different threads. Set that up using the share interface, as described in
the libcurl-share(3) man page.
## URL Parsing

View File

@ -32,7 +32,7 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REDIRECT_URL, char **urlp);
Pass a pointer to a char pointer to receive the URL a redirect *would* take
you to if you would enable CURLOPT_FOLLOWLOCATION(3). This can come handy if
you think using the built-in libcurl redirect logic is not good enough for you
but you would still prefer to avoid implementing all the magic of figuring out
but you would still prefer to avoid implementing all the logic of figuring out
the new URL.
This URL is also set if the CURLOPT_MAXREDIRS(3) limit prevented a redirect to

View File

@ -66,7 +66,7 @@ int main(void)
if(curl) {
CURLcode result;
curl_easy_setopt(curl, CURLOPT_URL, "ws://example.com/");
/* tell curl we deal with all the WebSocket magic ourselves */
/* tell curl we deal with all the WebSocket logic ourselves */
curl_easy_setopt(curl, CURLOPT_WS_OPTIONS, CURLWS_RAW_MODE);
result = curl_easy_perform(curl);
curl_easy_cleanup(curl);