]> granicus.if.org Git - curl/commitdiff
curl_multi_wait.3: clarify numfds being used if not NULL
authorDaniel Stenberg <daniel@haxx.se>
Tue, 25 Nov 2014 10:48:38 +0000 (11:48 +0100)
committerDaniel Stenberg <daniel@haxx.se>
Tue, 25 Nov 2014 10:48:38 +0000 (11:48 +0100)
docs/libcurl/curl_multi_wait.3

index 21ade930b1989cdb167f1cc2106938ffc9e07740..a76fba3606c3dee7efff4167e9ab567fedfc2976 100644 (file)
@@ -5,7 +5,7 @@
 .\" *                            | (__| |_| |  _ <| |___
 .\" *                             \___|\___/|_| \_\_____|
 .\" *
-.\" * Copyright (C) 1998 - 2013, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
 .\" *
 .\" * This software is licensed as described in the file COPYING, which
 .\" * you should have received as part of this distribution. The terms
@@ -33,9 +33,9 @@ CURLMcode curl_multi_wait(CURLM *multi_handle,
                           int *numfds);
 .ad
 .SH DESCRIPTION
-This function polls on all file descriptors used by the curl easy handles
-contained in the given multi handle set.  It will block until activity is
-detected on at least one of the handles or \fItimeout_ms\fP has passed.
+\fIcurl_multi_wait(3)\fP polls all file descriptors used by the curl easy
+handles contained in the given multi handle set.  It will block until activity
+is detected on at least one of the handles or \fItimeout_ms\fP has passed.
 Alternatively, if the multi handle has a pending internal timeout that has a
 shorter expiry time than \fItimeout_ms\fP, that shorter time will be used
 instead to make sure timeout accuracy is reasonably kept.
@@ -43,7 +43,7 @@ instead to make sure timeout accuracy is reasonably kept.
 The calling application may pass additional curl_waitfd structures which are
 similar to \fIpoll(2)\fP's pollfd structure to be waited on in the same call.
 
-On completion, if \fInumfds\fP is supplied, it will be populated with the
+On completion, if \fInumfds\fP is non-NULL, it will be populated with the
 total number of file descriptors on which interesting events occured. This
 number can include both libcurl internal descriptors as well as descriptors
 provided in \fIextra_fds\fP.