Improve the documentation of profiling with "perf maps"
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 77.2k
- フォーク
- 35.9k
- PR マージ指標
- PR 指標を取得中
説明
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
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Doc/howto/perf_profiling.rstから始め、PR #136461の変更を確認して、現在のLinux perfとmacOS samplyの対応範囲を把握します。samplyがサポートするperfモードを比較し、プラットフォームのサポート、セットアップ、モードの選択が明確になるようにガイドを再構成します。完了の条件は、ドキュメントでLinuxとmacOSの両方におけるプロファイリング方法と、各モードを使用するタイミングが正確に説明されていることです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- linux, macos, python
- 領域
- documentation, performance
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 52/100