python / python/cpython

Improve the documentation of profiling with "perf maps"

Abierto
#137,019 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

docs OS-linux OS-mac performance topic-profiling
Lenguaje dominante
Python
Estrellas
77.2k
Forks
35.9k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con Doc/howto/perf_profiling.rst y revisa los cambios de PR #136461 para comprender la cobertura actual de Linux perf y macOS samply. Compara los modos de perf compatibles con samply y reorganiza la guía para que la compatibilidad de plataformas, la configuración y la selección del modo sean claras. La tarea estará terminada cuando la documentación explique correctamente cómo hacer profiling tanto en Linux como en macOS y cuándo usar cada modo.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
linux, macos, python
Área
documentation, performance
Tipo de issue
Documentación
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
52/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.