gh-96143: Improve perf profiler docs by erlend-aasland · Pull Request #96445 · python/cpython

erlend-aasland · 2022-08-30T22:05:54Z

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

Issue: Allow the linux perf profiler to see Python calls #96143

Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>

pablogsal

LGTM

Great work! 👍

vstinner

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

erlend-aasland · 2022-08-31T07:29:37Z

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

gpshead

thanks for the edits!

bedevere-bot · 2022-08-31T23:20:49Z

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

vstinner

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

erlend-aasland · 2022-09-04T21:10:29Z

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

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

pablogsal · 2022-10-25T18:25:06Z

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

erlend-aasland · 2022-10-25T18:26:34Z

@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

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.

pythongh-96143: Improve perf profiler docs
41bab32

erlend-aasland requested review from ezio-melotti, gpshead and pablogsal August 30, 2022 22:05

bedevere-bot added the awaiting core review label Aug 30, 2022

erlend-aasland commented Aug 30, 2022
View reviewed changes

Comment threadDoc/howto/perf_profiling.rst

pablogsal reviewed Aug 30, 2022
View reviewed changes

Comment threadDoc/library/sys.rst

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 threadDoc/howto/perf_profiling.rst Outdated

you => your
574b39a

pablogsal reviewed Aug 30, 2022
View reviewed changes

Comment threadDoc/whatsnew/3.12.rst Outdated

Fixup What's New entry
9388964
Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>

pablogsal reviewed Aug 30, 2022
View reviewed changes

Comment threadDoc/howto/perf_profiling.rst Outdated

Address review: add links to perf wiki, and use bullet points
31c0eb8

erlend-aasland mentioned this pull request Aug 30, 2022
gh-96143: Allow Linux perf profiler to see Python calls #96123
Merged

pablogsal approved these changes Aug 30, 2022
View reviewed changes

bedevere-bot added awaiting merge and removed awaiting core review labels Aug 30, 2022

vstinner reviewed Aug 30, 2022
View reviewed changes

Comment threadDoc/howto/perf_profiling.rst
Comment threadDoc/using/cmdline.rst Outdated
Comment threadDoc/using/cmdline.rst Outdated

Address Victor's review
9c72023

erlend-aasland requested a review from vstinner August 31, 2022 08:40

ezio-melotti reviewed Aug 31, 2022
View reviewed changes

https
3756252

gpshead requested changes Aug 31, 2022
View reviewed changes

Comment threadDoc/howto/perf_profiling.rst Outdated
Comment threadDoc/howto/perf_profiling.rst Outdated
Comment threadDoc/howto/perf_profiling.rst Outdated
Comment threadDoc/whatsnew/3.12.rst Outdated

bedevere-bot added awaiting changes and removed awaiting merge labels Aug 31, 2022

ezio-melotti reviewed Sep 1, 2022
View reviewed changes

Comment threadDoc/howto/perf_profiling.rst Outdated

vstinner reviewed Sep 1, 2022
View reviewed changes

Comment threadDoc/howto/perf_profiling.rst Outdated

erlend-aasland added 2 commits September 4, 2022 23:07

Address reviews
cbe8b16

Merge branch 'main' into perf-docs
9ce60ea

ezio-melotti reviewed Sep 17, 2022
View reviewed changes

Comment threadDoc/howto/perf_profiling.rst Outdated
Comment threadDoc/howto/perf_profiling.rst
Comment threadDoc/library/sys.rst Outdated
Comment threadPython/clinic/sysmodule.c.h

ezio-melotti mentioned this pull request Sep 17, 2022
Default role does not detect default roles starting with a single quote sphinx-contrib/sphinx-lint#40
Closed

Erlend E. Aaslandand 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 self-assigned this Oct 25, 2022

Merge branch 'main' into perf-docs
0d41b95

pablogsal added the skip news label Oct 26, 2022

pablogsal approved these changes Oct 26, 2022
View reviewed changes

bedevere-bot added awaiting merge and removed awaiting changes labels Oct 26, 2022

gpshead approved these changes Oct 26, 2022
View reviewed changes

pablogsal merged commit 723ebe7 into python:mainOct 27, 2022

bedevere-bot removed the awaiting merge label 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

dependabotBot added a commit to ronaldoussoren/cpython that referenced this pull request Nov 14, 2022
pythongh-96143: Improve perf profiler docs (python#96445)
63b6c66

Uh oh!

Uh oh!

Conversation

erlend-aasland commented Aug 30, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pablogsal left a comment

Choose a reason for hiding this comment

Uh oh!

vstinner left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

erlend-aasland commented Aug 31, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gpshead left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bedevere-bot commented Aug 31, 2022

Uh oh!

Uh oh!

vstinner left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

erlend-aasland commented Sep 4, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pablogsal commented Oct 25, 2022

Uh oh!

erlend-aasland commented Oct 25, 2022

Uh oh!

pablogsal left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

erlend-aasland commented Aug 30, 2022•
edited
Loading