summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2019-11-28 15:56:12 +0100
committerDaniel Stenberg <daniel@haxx.se>2019-11-28 22:29:18 +0100
commitbc64377ff8386d4f809806b6286f43e5aff19922 (patch)
treee72362d3daa956952ea442ea78a4c77b19ff811f
parentcc4cf93e52802e6b450a3dceae86c4f289a0bb65 (diff)
downloadcurl-bc64377ff8386d4f809806b6286f43e5aff19922.tar.gz
docs: add more references to curl_multi_poll
Fixes #4643 Closes #4652
-rw-r--r--docs/libcurl/curl_multi_wait.35
-rw-r--r--docs/libcurl/libcurl-multi.32
2 files changed, 4 insertions, 3 deletions
diff --git a/docs/libcurl/curl_multi_wait.3 b/docs/libcurl/curl_multi_wait.3
index 9ff4651c7..c1ae14fd1 100644
--- a/docs/libcurl/curl_multi_wait.3
+++ b/docs/libcurl/curl_multi_wait.3
@@ -49,7 +49,8 @@ number can include both libcurl internal descriptors as well as descriptors
provided in \fIextra_fds\fP.
If no extra file descriptors are provided and libcurl has no file descriptor
-to offer to wait for, this function will return immediately.
+to offer to wait for, this function will return immediately. (Try
+\fIcurl_multi_poll(3)\fP instead if you rather avoid this behavior.)
This function is encouraged to be used instead of select(3) when using the
multi interface to allow applications to easier circumvent the common problem
@@ -119,4 +120,4 @@ CURLMcode type, general libcurl multi interface error code. See
.SH AVAILABILITY
This function was added in libcurl 7.28.0.
.SH "SEE ALSO"
-.BR curl_multi_fdset "(3), " curl_multi_perform "(3)"
+.BR curl_multi_fdset "(3), " curl_multi_perform "(3)", curl_multi_poll "(3) ",
diff --git a/docs/libcurl/libcurl-multi.3 b/docs/libcurl/libcurl-multi.3
index 5d7c27b95..4674abdce 100644
--- a/docs/libcurl/libcurl-multi.3
+++ b/docs/libcurl/libcurl-multi.3
@@ -85,7 +85,7 @@ returns back to the calling application.
Your application extracts info from libcurl about when it would like to get
invoked to transfer data or do other work. The most convenient way is to use
-\fIcurl_multi_wait(3)\fP that will help you wait until the application should
+\fIcurl_multi_poll(3)\fP that will help you wait until the application should
call libcurl again. The older API to accomplish the same thing is
\fIcurl_multi_fdset(3)\fP that extracts fd_sets from libcurl to use in
select() or poll() calls in order to get to know when the transfers in the