Remove examples from deprecated options - #13540
Closed
danielgustafsson wants to merge 2 commits into
Closed
Conversation
Manpages which document deprecated CURLOPT_ or CURLINFO_ are not required to have an EXAMPLE section since they might effectively be dead no-ops which we don't want to trick users into believing they can use by copying example code. Closes: #xxxx
CURLOPT_EGDSOCKET and CURLOPT_RANDOM_FILE are both completely dead so remove their example sections since the code there is useless. There is still a way to inject a random file for OpenSSL older than 1.1.0 but it's not what the example showed (and it's not even done with this option) so we refrain from documenting it here.
danielgustafsson
changed the title
bagder
approved these changes
May 6, 2024
danielgustafsson
added a commit
that referenced
this pull request
May 6, 2024
CURLOPT_EGDSOCKET and CURLOPT_RANDOM_FILE are both completely dead so remove their example sections since the code there is useless. There is still a way to inject a random file for OpenSSL older than 1.1.0 but it's not what the example showed (and it's not even done with this option) so we refrain from documenting it here. Closes: #13540 Reviewed-by: Daniel Stenberg <daniel@haxx.se>
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
2 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.
Manpages which document deprecated
CURLOPT_orCURLINFO_should not be required to have an EXAMPLE section since they might effectively be dead no-ops which we don't want to trick users into believing they can use by copying example code.CURLOPT_EGDSOCKETandCURLOPT_RANDOM_FILEare both completely dead so remove their example sections since the code there is useless. There is still a way to inject a random file for OpenSSL older than 1.1.0 but it's not what the example showed (and it's not even done with this option) so we refrain from documenting it here.