Improve the documentation of profiling with "perf maps"
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 77.2k
- Fork
- 35.9k
- Chỉ số merge pull request
- Chỉ số pull request đang chờ
Mô tả
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
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu với Doc/howto/perf_profiling.rst và xem xét các thay đổi từ PR #136461 để hiểu phạm vi hỗ trợ hiện tại của Linux perf và macOS samply. So sánh các chế độ perf được samply hỗ trợ và sắp xếp lại hướng dẫn để việc hỗ trợ nền tảng, thiết lập và lựa chọn chế độ được rõ ràng. Công việc được xem là hoàn tất khi tài liệu giải thích chính xác cách profiling trên cả Linux và macOS, cũng như thời điểm sử dụng từng chế độ.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- linux, macos, python
- Lĩnh vực
- documentation, performance
- Loại issue
- Tài liệu
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 52/100