CPP-990 Add brief section on OpenSSL 3.x to building doc#557
CPP-990 Add brief section on OpenSSL 3.x to building doc#557absurdfarce merged 4 commits intomasterfrom
Conversation
| platforms. | ||
|
|
||
| Given these results we expect the driver to behave well with OpenSSL 3.x. | ||
|
|
There was a problem hiding this comment.
@emeliawilkinson24 and @weideng1: I'm not 💯 convinced this paragraph is actually useful. The same information is provided in more detail in the comments of CPP-990 and I'm not sure a paragraph like the one above gives the user any tools to make their experience with the driver better.
There was a problem hiding this comment.
@absurdfarce I agree. I think the brief note on open SSL 3.x is largely speculative, the only part definitely needed there in my opinion is "Two officially supported platforms (Ubuntu 22.04 and Rocky Linux 9.2) come with OpenSSL 3.x by default and the unit and integration tests all pass on these platforms." We shouldn't say we think something will work well, we want to tell users we tested it and according to everything we know it definitely works.
There was a problem hiding this comment.
That makes sense to me @emeliawilkinson24 . After the other edits you had on your review I think we can get to something I can live with if I just remove that last sentence. I'll give it a shot and see what it looks like.
There was a problem hiding this comment.
Okay, I liked how things look with that sentence out. Take another pass when you have some time @emeliawilkinson24 and let me know what you think!
weideng1
left a comment
There was a problem hiding this comment.
Good explanation of the background with the additional paragraph you added. LGTM
| * [libuv] 1.x | ||
| * Kerberos v5 ([Heimdal] or [MIT]) \* | ||
| * [OpenSSL] v1.0.x or v1.1.x \*\* | ||
| * [OpenSSL] v1.0.x, v1.1.x or v3.x \*\* |
There was a problem hiding this comment.
| * [OpenSSL] v1.0.x, v1.1.x or v3.x \*\* | |
| * [OpenSSL] v1.0.x, v1.1.x, or v3.x \*\* |
There was a problem hiding this comment.
Wait, are we gonna have to duke it out about the Harvard comma now? :)
|
|
||
| ### A Brief Note on OpenSSL 3.x | ||
|
|
||
| Migrating from OpenSSL 1.1.x to 3.x largely involves avoiding the use of many functions which are now deprecated (consult |
There was a problem hiding this comment.
| Migrating from OpenSSL 1.1.x to 3.x largely involves avoiding the use of many functions which are now deprecated (consult | |
| Migrating from OpenSSL 1.1.x to 3.x avoids using many functions which are now deprecated (consult |
There was a problem hiding this comment.
I don't think this one quite works. "Migrating from OpenSSL X to Y avoids using many functions which are now deprecated" seems wrong. The intent is to communicate what migration involves, not the effect of migration.
| platforms. | ||
|
|
||
| Given these results we expect the driver to behave well with OpenSSL 3.x. | ||
|
|
There was a problem hiding this comment.
@absurdfarce I agree. I think the brief note on open SSL 3.x is largely speculative, the only part definitely needed there in my opinion is "Two officially supported platforms (Ubuntu 22.04 and Rocky Linux 9.2) come with OpenSSL 3.x by default and the unit and integration tests all pass on these platforms." We shouldn't say we think something will work well, we want to tell users we tested it and according to everything we know it definitely works.
Co-authored-by: Emelia <105240296+emeliawilkinson24@users.noreply.github.com>
Co-authored-by: Emelia <105240296+emeliawilkinson24@users.noreply.github.com>
No description provided.