CPP-990 Add brief section on OpenSSL 3.x to building doc #557
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -27,7 +27,7 @@ The C/C++ driver depends on the following software: | |||||
| * [CMake] v2.8.12+ | ||||||
| * [libuv] 1.x | ||||||
| * Kerberos v5 ([Heimdal] or [MIT]) \* | ||||||
| * [OpenSSL] v1.0.x, v1.1.x or v3.x \*\* | ||||||
| * [zlib] v1.x \*\*\* | ||||||
|
|
||||||
| __\*__ Use the `CASS_USE_KERBEROS` CMake option to enable/disable Kerberos | ||||||
|
|
@@ -42,6 +42,13 @@ __\*\*\*__ Use the `CASS_USE_ZLIB` CMake option to enable/disable zlib support. | |||||
| Disabling this option will disable DataStax Astra support | ||||||
| within the driver; defaults to `On`. | ||||||
|
|
||||||
| ### 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 | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
Contributor
Author
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. |
||||||
| the [migration guide] for details). The driver does not use any of these functions so we expect the transition to OpenSSL | ||||||
| 3.x to be relatively painless. Note that 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. | ||||||
|
|
||||||
|
Contributor
Author
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.
Contributor
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.
Contributor
Author
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.
Contributor
Author
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! |
||||||
| ## Linux/Mac OS | ||||||
|
|
||||||
| The driver is known to build on CentOS/RHEL 6/7/8, Mac OS X 10.10/10.11 (Yosemite | ||||||
|
|
@@ -335,3 +342,4 @@ cmake -G "Visual Studio 16 2019" -A x64 -DCASS_BUILD_UNIT_TESTS=On .. | |||||
| [MIT]: https://web.mit.edu/kerberos | ||||||
| [OpenSSL]: https://www.openssl.org | ||||||
| [zlib]: https://www.zlib.net | ||||||
| [migration guide]: https://www.openssl.org/docs/man3.0/man7/migration_guide.html | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wait, are we gonna have to duke it out about the Harvard comma now? :)