]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
docs: avoid using the word 'magic'
authorDaniel Stenberg <daniel@haxx.se>
Tue, 3 Mar 2026 12:53:36 +0000 (13:53 +0100)
committerDaniel Stenberg <daniel@haxx.se>
Tue, 3 Mar 2026 14:32:13 +0000 (15:32 +0100)
It's never actually magic.

Closes #20796

docs/BUGS.md
docs/FAQ.md
docs/TODO.md
docs/cmdline-opts/MANPAGE.md
docs/libcurl/curl_easy_pause.md
docs/libcurl/libcurl-security.md
docs/libcurl/libcurl.md
docs/libcurl/opts/CURLINFO_REDIRECT_URL.md
docs/libcurl/opts/CURLOPT_WS_OPTIONS.md

index 761f26e442ecfbe1c643a9a7c9d163d0a25e74db..5f3704771ba9406d63f4b16ae9d5863ce2b1265a 100644 (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.
index a3e9a9fa37edcd9289428fedf221df008b2e7793..9324691bc7a3ea9d7247e7432201caee0876c1ee 100644 (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
index 402f6066c8ae5f1d59c9ec2214f3fcf5d463f495..1d2db67a4ccb5c9ebfd2cb46f21c634cf6c098c4 100644 (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)
index e768e9c46e21c7859939154797d429f9d5594f1f..fb952fa275b2c814776a264e333bcf9ec9bf2e30 100644 (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
index b6390058e89a184fb57e360f63741ddef743b4d0..f00fd28061cf3ce33a54fbba7670071bdb1c1466 100644 (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
+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.
 
index 17d9914c36c5ee83aacb5fa5e44c0aab7f51f436..b9b6e34ed10a74943da60b959e0e20be606576ed 100644 (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.
 
index 669550a3ac6e95e515ee3a6e42fa44c4dcf41f9d..652db461a584e547ffc0d9bcf6d92fdc3071fd60 100644 (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
 
index 6d25a66e76f99e63d4767b21c320e0e8cad5196f..df3a320b9287623e8e55b770833e23855be50716 100644 (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
index a76396f38c8faf19bd2d19b8f4c2b2cc130863ff..965183b38f53323759f4bdff060784936a272440 100644 (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);