This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Document PGO in devguide
Type: Stage:
Components: Documentation Versions: Python 3.11
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, gvanrossum
Priority: normal Keywords:

Created on 2021-06-29 23:35 by gvanrossum, last changed 2022-04-11 14:59 by admin.

Messages (2)
msg396764 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2021-06-29 23:35
The only docs for PGO seem to be in the toplevel README.rst. Sinec that is what's shown to all visitors to the GitHub repo, perhaps this information is not so useful there, and instead a section could be added to the devguide? (Ditto for LTO.)

Note that for Windows this info is in PCbuild/readme.txt. It's perhaps okay to keep it there, and just mention in the devguide that the Windows info in there.

FWIW, maybe we should get rid of the tradition that the toplevel README.rst file's heading gives the version? That tradition dates from the times when source distributions were done as tarballs... It would save one more place to update (there's another mention of the version later in README.rst which still points to 3.10).
msg396766 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2021-06-29 23:56
Hm, there is now also info on how to build in the end user documentation in Doc/using/configure.rst. I am actually confused by the intention of documenting information about *building* CPython in the same place where we document *using* Python (and sometimes CPython), esp. given that we have a devguide. Maybe one of the docs owners can clarify where they thing PGO should be documented, and why?
History
Date User Action Args
2022-04-11 14:59:47adminsetgithub: 88703
2021-06-29 23:56:45gvanrossumsetmessages: + msg396766
2021-06-29 23:35:17gvanrossumcreate