Document PGO in devguide

[KilJaeeun]

Hi! this is my first open source Pull Request in CPython Sprint at PyCon KR so it might be awkward. Added description of enable optimization option. Please take good care of me!

• Related issue

  • Document PGO in devguide cpython#88703

• I made this PullRequest with these references

  • https://docs.python.org/3/using/configure.html?highlight=lto#performance-options
  • https://github.com/python/cpython/blob/main/Doc/using/configure.rst#python-build-system
  • Document PGO in devguide cpython#88703

---

📚 Documentation preview 📚: https://cpython-devguide--1153.org.readthedocs.build/

[corona10]

@hugovk @CAM-Gerlach @AlexWaygood

Dear reviewers,
@KilJaeeun is a participant in the PyCon KR sprint.
This is the first PR to the OSS world in her life ever!

[AlexWaygood]

Thanks, it's really useful to document this! This looks pretty good.

Could you maybe start the section with a brief description of why you might or might not want to use this option? I worry that at the moment, people new to Python might think that this is the best option that they should use all the time (since "optimized" is a very positive adjective!)

Maybe the section could start with something like this?

If you are trying to improve the performance of Python, you will probably want to use an optimized build of CPython. It can take a lot longer to build CPython with optimizations enabled, and it's usually not necessary to do so. However, it's essential if you want accurate benchmark results for a proposed performance optimization.

Could you also please wrap each line to 80 characters, like the other paragraphs in this document?

[AlexWaygood]

Closing and reopening to retrigger the CLA bot

[cpython-cla-bot]

All commit authors signed the Contributor License Agreement.

[corona10]

@KilJaeeun

Would you like to update the PR with comments from other reviewers?

• Document PGO in devguide  #1153 (review)
• https://github.com/python/devguide/pull/1153/files#r1291623444

[KilJaeeun]

@corona10 @AlexWaygood
I reflected the code review Please check it out!

[AlexWaygood]

Thanks, nearly there! A few more small suggestions below. If you like my suggestions, you can apply them by clicking the "commit suggestion" button below each suggestion :)

[AA-Turner]

Depending on how much detail you want to go into, you could link the specific options themselves with :option`python:--enable-optimizations` or :option`python:--with-lto`.

---

Related, I was a little surprised to see configure options in d.p.o -- thinking about it, should we consider moving it to the devguide? I'm not sure many end-users build their own Python from sources...

A

[AlexWaygood]

Thanks, looks great!

[KilJaeeun]

@AlexWaygood
thank you for

you can apply them by clicking the "commit suggestion" button below each suggestion :)
this mention! i didn't know that.. thank you!!!

@AA-Turner
I didn't know how to specify detailed options, so I was thinking about it, but thank you. That's what I was looking for!

[AA-Turner]

Looks good overall! Thanks @KilJaeeun and again congratulations on your first PR!

A

The requested changes were made

[AlexWaygood]

Thanks again @KilJaeeun, this was a great first PR!