curl_multi_socket.3: remove callback and typical usage descriptions #8262
Conversation
This file contains 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
1. The callback is better described in the option for setting it. Having it in a single place reduces the risk that one of them is wrong. 2. The "typical usage" is wrong since the functions described in this man page are both deprecated so they cannot be used in any "typical" way anymore.
jay
reviewed
Jan 11, 2022
| The \fIaction\fP argument to the callback has one of five values: | ||
| .RS | ||
| .IP "CURL_POLL_NONE (0)" | ||
| register, not interested in readiness (yet) |
There was a problem hiding this comment.
note CURL_POLL_NONE is not mentioned in CURLMOPT_SOCKETFUNCTION
There was a problem hiding this comment.
I guess that proves my point... 😁
Looking at the code, I don't think CURL_POLL_NONE can actually be passed to the callback so I think it is correct to not document it as such.
This pull request was closed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 callback is better described in the option for setting it. Having
it in a single place reduces the risk that one of them is wrong.
The "typical usage" is wrong since the functions described in this
man page are both deprecated so they cannot be used in any "typical" way
anymore.