Document PGO in devguide

[gvanrossum]

BPO	44537
Nosy	@gvanrossum

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2021-06-29.23:35:17.230>
labels = ['3.11', 'docs']
title = 'Document PGO in devguide'
updated_at = <Date 2021-06-29.23:56:45.021>
user = 'https://github.com/gvanrossum'

bugs.python.org fields:

activity = <Date 2021-06-29.23:56:45.021>
actor = 'gvanrossum'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2021-06-29.23:35:17.230>
creator = 'gvanrossum'
dependencies = []
files = []
hgrepos = []
issue_num = 44537
keywords = []
message_count = 2.0
messages = ['396764', '396766']
nosy_count = 2.0
nosy_names = ['gvanrossum', 'docs@python']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue44537'
versions = ['Python 3.11']

[gvanrossum]

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).

[gvanrossum]

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?

[gvanrossum]

@corona10 Can you check if this is still undocumented? If not maybe we can just close it.

[corona10]

@corona10 Can you check if this is still undocumented? If not maybe we can just close it.

Well, it is still undocumented, but I will assign the issue to myself,
FYI, I am preparing the CPython Sprint at PyCon KR this year,
It could be a good first issue for the mentees.

https://2023.pycon.kr/sprint
Not registered yet, but I sent a request form yesterday.

[corona10]

@KilJaeeun Would you like to take a look?

[KilJaeeun]

!

[corona10]

The PR is merged, thank you @KilJaeeun :)
cc @gvanrossum