Docs: Add troubleshooting for OpenSSL build errors #1731
Conversation
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
Adds the --with-openssl-rpath=auto flag to help resolve "Python requires a OpenSSL 1.1.1 or newer" errors on Linux/WSL. Fixes python#1727.
|
All commit authors signed the Contributor License Agreement. |
Documentation build overview
Show files changed (3 files in total): 📝 3 modified | ➕ 0 added | ➖ 0 deleted
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR adds documentation for the --with-openssl-rpath=auto flag to the Unix build instructions in setup-building.rst.
Technical Context
On several modern Linux distributions and WSL environments, the CPython ./configure script can fail to link the SSL module correctly, even when a compatible OpenSSL version is present. This typically results in the error: Could not build the ssl module! Python requires a OpenSSL 1.1.1 or newer.
Using the --with-openssl-rpath=auto flag ensures the build system correctly identifies the runtime search path for OpenSSL, allowing the _ssl extension to build successfully.
Related Issue
Fixes #1727