Resolve inconsistency between curl_multi_perform and curl_multi_wait/poll documentation#20444
Closed
BillyONeal wants to merge 3 commits intocurl:masterfrom
Closed
Resolve inconsistency between curl_multi_perform and curl_multi_wait/poll documentation#20444BillyONeal wants to merge 3 commits intocurl:masterfrom
BillyONeal wants to merge 3 commits intocurl:masterfrom
Conversation
…poll documentation The `curl_multi_perform` documentation uses integer contextual conversion to `bool` to test the resulting `CURLMcode`, while other functions like `curl_multi_wait` and `curl_multi_poll` test against `CURLM_OK`. (I was initially confused by this as it looked like some docs call curl_multi_wait/poll on error, while some called only on success. But that was my misread, not a docs problem.) Also fixed the example to print which function call failed; previously an error reported by `curl_multi_perform` was printed as a failure of `curl_multi_wait`.
```
docs/libcurl/curl_multi_perform.md:76:8: warning: for with space (SPACEBEFOREPAREN)
for (;;) {
^
docs/libcurl/curl_multi_perform.md:79:82: warning: Longer than 79 columns (LONGLINE)
fprintf(stderr, "curl_multi_perform() failed, code %d.\n", (int)mresult);
checksrc: 0 errors and 2 warnings
checksrc: 0 errors and 4 warnings suppressed
```
vszakats
reviewed
Jan 27, 2026
Co-authored-by: Viktor Szakats <vszakats@users.noreply.github.com>
vszakats
approved these changes
Jan 27, 2026
bagder
approved these changes
Jan 27, 2026
Member
|
Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
curl_multi_performdocumentation (https://curl.se/libcurl/c/curl_multi_perform.html) uses integer contextual conversion toboolto test the resultingCURLMcode, while other functions likecurl_multi_waitandcurl_multi_polltest againstCURLM_OK( for example https://curl.se/libcurl/c/curl_multi_wait.html ). (I was initially confused by this as it looked like some docs call curl_multi_wait/poll on error, while some called only on success. I think it would be clearer to always test againstCURLM_OK)Also fixed the example to print which function call failed; previously an error reported by
curl_multi_performwas printed as a failure ofcurl_multi_wait. It may be better to fix that by removing the function name entirely as https://curl.se/libcurl/c/curl_multi_wait.html seems to do instead...