← 返回首页
gh-96143: Improve perf profiler docs by erlend-aasland · Pull Request #96445 · python/cpython · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

gh-96143: Improve perf profiler docs#96445

Merged
pablogsal merged 11 commits into
python:mainfrom
erlend-aasland:perf-docs
Oct 27, 2022
Merged

gh-96143: Improve perf profiler docs#96445
pablogsal merged 11 commits into
python:mainfrom
erlend-aasland:perf-docs

Conversation

erlend-aasland commented Aug 30, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor
  • Add What's New
  • Rewrite NEWS entry to match What's New
  • Document new sys APIs
  • Fix formatting here and there
  • Adjust wording a few places

erlend-aasland commented Aug 30, 2022
View reviewed changes
Comment thread Doc/howto/perf_profiling.rst Show resolved Hide resolved
pablogsal reviewed Aug 30, 2022
View reviewed changes
Comment thread Doc/library/sys.rst Show resolved Hide resolved
erlend-aasland marked this pull request as ready for review August 30, 2022 22:10
erlend-aasland commented Aug 30, 2022
View reviewed changes
Comment thread Doc/howto/perf_profiling.rst Outdated Show resolved Hide resolved
pablogsal reviewed Aug 30, 2022
View reviewed changes
Comment thread Doc/whatsnew/3.12.rst Outdated Show resolved Hide resolved
Fixup What's New entry …
9388964
Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
pablogsal reviewed Aug 30, 2022
View reviewed changes
Comment thread Doc/howto/perf_profiling.rst Outdated Show resolved Hide resolved
erlend-aasland mentioned this pull request Aug 30, 2022
Merged
pablogsal approved these changes Aug 30, 2022
View reviewed changes

pablogsal left a comment

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

LGTM

Great work! 👍

vstinner reviewed Aug 30, 2022
View reviewed changes

vstinner left a comment

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

I'm confused by "compatibility mode" wording whereas the env var is called "perf support". I would prefer to say that -X perf enables support for the Linux perf tool.

"Enable" support or "Add" support, not sure which one makes more send. Technically, the option adds something ;-)

The PyConfig member, the env var and the -X option have 3 different names which also confuse me. Would it make sense to rename the -X option to -X perfsupport to make it more consistent? If yes, I would suggest doing that in a separated PR.

The name "perf" is very generic and can mean many things. A newcomer might read it as: "use -X perf to get best performance" :-)

For me, "compatibility mode" sounds like "backward compatibility mode".

Comment thread Doc/howto/perf_profiling.rst Show resolved Hide resolved
Comment thread Doc/using/cmdline.rst Outdated Show resolved Hide resolved
Comment thread Doc/using/cmdline.rst Outdated Show resolved Hide resolved

erlend-aasland commented Aug 31, 2022

Copy link
Copy Markdown
Contributor Author

I'm confused by "compatibility mode" wording whereas the env var is called "perf support". I would prefer to say that -X perf enables support for the Linux perf tool.

+1

I've tried to address your review comments in 9c72023, @vstinner. Are you ok with those changes?

The PyConfig member, the env var and the -X option have 3 different names which also confuse me. Would it make sense to rename the -X option to -X perfsupport to make it more consistent? If yes, I would suggest doing that in a separated PR.

+1

ezio-melotti reviewed Aug 31, 2022
View reviewed changes
Comment thread Doc/howto/perf_profiling.rst Outdated Show resolved Hide resolved
Comment thread Doc/howto/perf_profiling.rst Outdated Show resolved Hide resolved
Comment thread Doc/howto/perf_profiling.rst Outdated Show resolved Hide resolved
Comment thread Doc/howto/perf_profiling.rst Outdated Show resolved Hide resolved
Comment thread Doc/howto/perf_profiling.rst Outdated Show resolved Hide resolved
Comment thread Doc/howto/perf_profiling.rst Outdated Show resolved Hide resolved
Comment thread Doc/whatsnew/3.12.rst Outdated Show resolved Hide resolved
Comment thread Python/clinic/sysmodule.c.h Outdated Show resolved Hide resolved
gpshead requested changes Aug 31, 2022
View reviewed changes

gpshead left a comment

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

thanks for the edits!

Comment thread Doc/howto/perf_profiling.rst Outdated Show resolved Hide resolved
Comment thread Doc/howto/perf_profiling.rst Outdated Show resolved Hide resolved
Comment thread Doc/howto/perf_profiling.rst Outdated Show resolved Hide resolved
Comment thread Doc/whatsnew/3.12.rst Outdated Show resolved Hide resolved

bedevere-bot commented Aug 31, 2022

Copy link
Copy Markdown

When you're done making the requested changes, leave the comment: I have made the requested changes; please review again.

ezio-melotti reviewed Sep 1, 2022
View reviewed changes
Comment thread Doc/howto/perf_profiling.rst Outdated Show resolved Hide resolved
vstinner reviewed Sep 1, 2022
View reviewed changes

vstinner left a comment

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Ezio made many interesting comments. I will wait until they are addressed to review again the PR ;-)

Comment thread Doc/howto/perf_profiling.rst Outdated Show resolved Hide resolved
17 hidden items Load more…

erlend-aasland commented Sep 4, 2022

Copy link
Copy Markdown
Contributor Author

Sorry for the delay. I finally got around to try to address the review. Please take a look at the changes.

ezio-melotti reviewed Sep 17, 2022
View reviewed changes
Comment thread Doc/howto/perf_profiling.rst Outdated Show resolved Hide resolved
Comment thread Doc/howto/perf_profiling.rst Show resolved Hide resolved
Comment thread Doc/library/sys.rst Outdated Show resolved Hide resolved
Comment thread Python/clinic/sysmodule.c.h Show resolved Hide resolved
ezio-melotti mentioned this pull request Sep 17, 2022
Closed
Erlend E. Aasland and others added 2 commits October 4, 2022 12:27
Apply suggestions from code review …
db4aaa2
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Merge branch 'main' into perf-docs
d68c77e

pablogsal commented Oct 25, 2022

Copy link
Copy Markdown
Member

@erlend-aasland can you fix the conflicts and I will land this? Thanks!

pablogsal self-assigned this Oct 25, 2022

erlend-aasland commented Oct 25, 2022

Copy link
Copy Markdown
Contributor Author

@erlend-aasland can you fix the conflicts and I will land this? Thanks!

Will do! Thanks for the heads-up. I forgot about this PR :)

pablogsal approved these changes Oct 26, 2022
View reviewed changes

pablogsal left a comment

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Thanks a lot for the fixes! ❤️

I plan to land this this week as all the feedback has been addressed but I will give some time in case someone wants to request some further changes.

pablogsal merged commit 723ebe7 into python:main Oct 27, 2022
erlend-aasland deleted the perf-docs branch October 27, 2022 15:20
gvanrossum pushed a commit to gvanrossum/cpython that referenced this pull request Oct 28, 2022
pythongh-96143: Improve perf profiler docs (python#96445)
18ac789
dependabot Bot added a commit to ronaldoussoren/cpython that referenced this pull request Nov 14, 2022
pythongh-96143: Improve perf profiler docs (python#96445)
63b6c66
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

vstinner vstinner left review comments
ezio-melotti ezio-melotti left review comments
gpshead gpshead approved these changes
pablogsal pablogsal approved these changes

Assignees

pablogsal

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

Footer

© 2026 GitHub, Inc.