Improve the documentation of profiling with "perf maps"
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 35.9k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
The documentation lives here: https://github.com/python/cpython/blob/d6cf05b5d00abbfdf9008d646c14c6ef7c83b61a/Doc/howto/perf_profiling.rst
Before #136461, cpython only had support for Linux perf profiling. But with this PR it now supports both Linux and macOS through samply. I updated the documentation to include this, but it's not super great currently because previously it was written with the assumption that it was only supported by Linux perf. So it would be good to restructure this doc in a better way, and add more information related to macOS profiling using samply.
Also samply supports both perf modes so it would be good to clarify when to use them.
cc @pablogsal @hugovk
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit Doc/howto/perf_profiling.rst und prüfe die Änderungen aus PR #136461, um den aktuellen Abdeckungsstand von Linux perf und macOS samply zu verstehen. Vergleiche die von samply unterstützten perf-Modi und ordne den Leitfaden neu, sodass Plattformunterstützung, Einrichtung und Modusauswahl klar sind. Die Aufgabe ist erledigt, wenn die Dokumentation das Profiling sowohl unter Linux als auch unter macOS korrekt erklärt und angibt, wann welcher Modus verwendet werden sollte.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- linux, macos, python
- Bereich
- documentation, performance
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 52/100