Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove examples from deprecated options #13540

Closed
wants to merge 2 commits into from

Conversation

danielgustafsson
Copy link
Member

Manpages which document deprecated CURLOPT_ or CURLINFO_ 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_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.

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.
@github-actions github-actions bot added the tests label May 5, 2024
@danielgustafsson danielgustafsson changed the title Dg no examples Remove examples from deprecated options 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

None yet

2 participants