gh-112301: Update disable safety and enable slow safety configure options documentation #122758
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
AA-Turner
reviewed
Aug 7, 2024
Doc/using/configure.rst
Outdated
|
|
||
| .. option:: --disable-safety | ||
|
|
||
| Disable compiler options that are recommended by `OpenSSF`_ for security reasons with no performance overhead. |
There was a problem hiding this comment.
Suggested change
| Disable compiler options that are recommended by `OpenSSF`_ for security reasons with no performance overhead. | |
| Disable compiler options that are `recommended by OpenSSF`_ for security reasons with no performance overhead. |
Doc/using/configure.rst
Outdated
| * `-fstack-protector-strong`_: Enable run-time checks for stack-based buffer overflows. | ||
| * `-Wtrampolines`_: Enable warnings about trampolines that require executable stacks. | ||
|
|
||
| .. _OpenSSF: https://github.com/ossf/wg-best-practices-os-developers/blob/main/docs/Compiler-Hardening-Guides/Compiler-Options-Hardening-Guide-for-C-and-C++.md |
There was a problem hiding this comment.
Suggested change
| .. _OpenSSF: https://github.com/ossf/wg-best-practices-os-developers/blob/main/docs/Compiler-Hardening-Guides/Compiler-Options-Hardening-Guide-for-C-and-C++.md | |
| .. _recommended by OpenSSF: https://github.com/ossf/wg-best-practices-os-developers/blob/main/docs/Compiler-Hardening-Guides/Compiler-Options-Hardening-Guide-for-C-and-C++.md |
Doc/using/configure.rst
Outdated
| When this option is enabled, CPython will not be built with the compiler options listed below. | ||
|
|
||
| .. _OpenSSF: https://openssf.org/ | ||
| Compiler options that are disabled with this option: |
There was a problem hiding this comment.
Suggested change
| Compiler options that are disabled with this option: | |
| The following compiler options are disabled with :option:`!--disable-safety`: |
Doc/using/configure.rst
Outdated
| If this option is not enabled, CPython will not be built based on safety compiler options which performance impact. | ||
| When this option is enabled, CPython will be built with the compiler options listed below. | ||
|
|
||
| Compiler options that are enabled with this option: |
There was a problem hiding this comment.
Suggested change
| Compiler options that are enabled with this option: | |
| The following compiler options are enabled with :option:`!--enable-slower-safety`: |
Doc/using/configure.rst
Outdated
| * `-D_FORTIFY_SOURCE=3`_: Fortify sources with compile- and run-time checks for unsafe libc usage and buffer overflows. | ||
|
|
||
| .. _OpenSSF: https://openssf.org/ | ||
| .. _OpenSSF: https://github.com/ossf/wg-best-practices-os-developers/blob/main/docs/Compiler-Hardening-Guides/Compiler-Options-Hardening-Guide-for-C-and-C++.md |
There was a problem hiding this comment.
You don't need to (and shouldn't) redefine link targets in the same document
Suggested change
| .. _OpenSSF: https://github.com/ossf/wg-best-practices-os-developers/blob/main/docs/Compiler-Hardening-Guides/Compiler-Options-Hardening-Guide-for-C-and-C++.md |
There was a problem hiding this comment.
Removed superfluous link
Doc/using/configure.rst
Outdated
|
|
||
| .. option:: --enable-slower-safety | ||
|
|
||
| Enable compiler options that are recommended by `OpenSSF`_ for security reasons which require overhead. |
There was a problem hiding this comment.
Suggested change
| Enable compiler options that are recommended by `OpenSSF`_ for security reasons which require overhead. | |
| Enable compiler options that are `recommended by OpenSSF`_ for security reasons which require overhead. |
corona10
reviewed
Aug 7, 2024
There was a problem hiding this comment.
Can we introduce the options here, too? or separate PR?
https://github.com/python/cpython/blob/main/Doc/whatsnew/3.14.rst
corona10
approved these changes
Aug 8, 2024
We could probably do a separate PR. We will be enabling strictly warning options once the devguide is updated that can be included there as well. |
|
@nohlson does this need backports? A |
No we do not need to backport these changes |
blhsing
pushed a commit
to blhsing/cpython
that referenced
this pull request
Aug 22, 2024
…ble-safety`` and ``--enable-slower-safety``) (python#122758) Co-authored-by: Adam Turner <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
These changes add more information to docs related to the new configure options
--disable-safetyand--enable-slow-safety. Links in docs point directly to the OpenSSF guidance for particular compiler options suggested in this comment.📚 Documentation preview 📚: https://cpython-previews--122758.org.readthedocs.build/