Skip to content

gh-158010: Avoid recommending out-of-date OpenSSL in configure doc - #158266

Merged
zware merged 4 commits into
python:mainfrom
zware:fix_configure_doc_openssl_rec
Sep 28, 2026
Merged

gh-158010: Avoid recommending out-of-date OpenSSL in configure doc#158266
zware merged 4 commits into
python:mainfrom
zware:fix_configure_doc_openssl_rec

Conversation

@zware

@zware zware commented Sep 27, 2026 •
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown
Member

To address @hugovk's comment on GH-158015, this adjusts the configure doc to avoid recommending a concrete version of OpenSSL at all, but instead point to what should be up-to-date resources and explain things a bit in prose.

This patch won't backport all the way to 3.13, but I plan to backport the idea manually after there's some agreement on the message.

@zware zware added the docs Documentation in the Doc dir label Sep 27, 2026
@zware
zware requested a review from itamaro as a code owner September 27, 2026 02:01
@zware
zware requested a review from hugovk September 27, 2026 02:01
@zware
zware requested a review from picnixz September 27, 2026 02:01
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Sep 27, 2026
@bedevere-app bedevere-app Bot mentioned this pull request Sep 27, 2026
Closed
@read-the-docs-community

read-the-docs-community Bot commented Sep 27, 2026 •
edited
Loading

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #34792979 | 📁 Comparing f8dea76 against main (6af40a6)

  🔍 Preview build  

5 files changed · ± 5 modified

± Modified

hugovk
hugovk approved these changes Sep 27, 2026
View reviewed changes
Comment thread Doc/using/configure.rst Outdated
Comment thread Doc/using/configure.rst Outdated
StanFromIreland
StanFromIreland reviewed Sep 27, 2026
View reviewed changes
Comment thread Doc/using/configure.rst
* - `OpenSSL <https://openssl-library.org/>`_
- | 3.0.18 recommended
| (1.1.1 minimum)
- [8]_

@StanFromIreland StanFromIreland Sep 27, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
- [8]_
- 1.1.1 [8]_

I think keeping the bare minimum here would be reasonable?

@zware zware Sep 27, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Honestly, I would prefer not to mention 1.1.1 at all: realistically, nobody reading this should ever use it, and anyone who really needs to use it anyway should already know what they're doing. I only keep it in the prose note because it's technically the minimum.

Comment thread Doc/using/configure.rst Outdated
zware and others added 3 commits September 27, 2026 17:55
@zware @hugovk
Apply batched suggestions from code review
397a027 
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@zware @StanFromIreland
Rewording
ce5c202 
Co-Authored-By: Stan Ulbrych <stan@python.org>
@zware
Re-wrap
f8dea76
@zware zware mentioned this pull request Sep 28, 2026
Merged
@zware
zware merged commit 869a505 into python:main Sep 28, 2026
31 checks passed
@zware
zware deleted the fix_configure_doc_openssl_rec branch September 28, 2026 15:08
@zware zware added the needs backport to 3.13 bugs and security fixes label Sep 28, 2026
@zware zware added needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes labels Sep 28, 2026
@miss-islington-app

miss-islington-app Bot commented Sep 28, 2026

Copy link
Copy Markdown

Thanks @zware for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

@miss-islington-app

miss-islington-app Bot commented Sep 28, 2026

Copy link
Copy Markdown

Thanks @zware for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

@miss-islington-app

miss-islington-app Bot commented Sep 28, 2026

Copy link
Copy Markdown

Thanks @zware for the PR 🌮🎉.. I'm working now to backport this PR to: 3.15.
🐍🍒⛏🤖

@miss-islington-app

miss-islington-app Bot commented Sep 28, 2026

Copy link
Copy Markdown

Sorry, @zware, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 869a50574fffac659dad2996591448a7270ec6f0 3.13

@miss-islington-app

miss-islington-app Bot commented Sep 28, 2026

Copy link
Copy Markdown

Sorry, @zware, I could not cleanly backport this to 3.14 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 869a50574fffac659dad2996591448a7270ec6f0 3.14

@miss-islington-app

miss-islington-app Bot commented Sep 28, 2026

Copy link
Copy Markdown

Sorry, @zware, I could not cleanly backport this to 3.15 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 869a50574fffac659dad2996591448a7270ec6f0 3.15

@bedevere-app

bedevere-app Bot commented Sep 28, 2026

Copy link
Copy Markdown

GH-158349 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label Sep 28, 2026
@bedevere-app

bedevere-app Bot commented Sep 28, 2026

Copy link
Copy Markdown

GH-158350 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Sep 28, 2026
hugovk added a commit that referenced this pull request Sep 28, 2026
@zware @hugovk @StanFromIreland
[3.15] gh-158010: Avoid recommending out-of-date OpenSSL in configure…
b1a5fc1 
… doc (GH-158266) (#158349)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Stan Ulbrych <stan@python.org>
@bedevere-app

bedevere-app Bot commented Sep 28, 2026

Copy link
Copy Markdown

GH-158351 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Sep 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovk hugovk hugovk approved these changes
@picnixz picnixz picnixz approved these changes
@StanFromIreland StanFromIreland StanFromIreland approved these changes
@erlend-aasland erlend-aasland Awaiting requested review from erlend-aasland erlend-aasland is a code owner
@corona10 corona10 Awaiting requested review from corona10 corona10 is a code owner
@AA-Turner AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner
@emmatyping emmatyping Awaiting requested review from emmatyping emmatyping is a code owner
@itamaro itamaro Awaiting requested review from itamaro itamaro is a code owner

Assignees

@zware zware

Labels

docs Documentation in the Doc dir skip news topic-SSL

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@zware @hugovk @picnixz @StanFromIreland