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

Improve cipher options documentation #14407

Closed
wants to merge 1 commit into from
Closed

Conversation

jan2000
Copy link
Contributor

@jan2000 jan2000 commented Aug 5, 2024

No description provided.

res = curl_easy_perform(curl);
curl_easy_cleanup(curl);
}
}
~~~

# HISTORY

Added in 7.52.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to mention "added in", because that is inserted automatically in the %AVAILABILITY% section so this ends up repeated info.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please re-review updated updated content.


For OpenSSL, wolfSSL, mbedTLS, Secure Transport and BearSSL a valid example
of a cipher list is:
**ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we maybe insert spaces after the colons or something to break this very long line? To make it more readable in the rendered outputs (man page or curl -M).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, I tried another approach. But it is a bit like shoving a maxi-single through a letterbox.

docs/libcurl/opts/CURLOPT_SSL_CIPHER_LIST.md Outdated Show resolved Hide resolved
docs/cmdline-opts/tls13-ciphers.md Outdated Show resolved Hide resolved
docs/cmdline-opts/proxy-ciphers.md Outdated Show resolved Hide resolved
docs/cmdline-opts/proxy-tls13-ciphers.md Outdated Show resolved Hide resolved
@bagder
Copy link
Member

bagder commented Aug 14, 2024

I just did #14543 that solves the problem with long example lines in the output.

@bagder
Copy link
Member

bagder commented Aug 16, 2024

Try rebasing this on master now and force-pushing and I believe it should do better

@jan2000
Copy link
Contributor Author

jan2000 commented Aug 16, 2024

Rebased and added changes for #14535.

@bagder bagder closed this in 88727f7 Aug 17, 2024
@bagder
Copy link
Member

bagder commented Aug 17, 2024

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants