mapbox / mapbox/cpp

Dual docs for llvm usage: cli and Xcode

Abierto
#8 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Sin datos de lenguaje
Estrellas
110
Forks
17
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

XCode/Apple is driving the development of llvm tools. These tools can and do work on the command line on both os x and linux. So we should prioritize documenting cli usage in a cross platform way. However users of XCode, notably for mobile development, can and should prefer to use features of llvm like the sanitizers from within Xcode GUI (with the caveat that at the time of writing Xcode only supports the address sanitizer and not thread, memory, undefined).

As such our docs ideally should target the three ways you'd use llvm:

- cli on linux (installed with mason)
- cli on osx (installed with mason or recent Xcode command line tools - identical behavior to linux except for missing sanitizers)
- XCode UI on OS X for macOS and iOS development (installed with XCode)

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

No se nombran archivos ni pruebas. Empieza por localizar la documentación existente de LLVM y sus puntos de entrada de CLI y Xcode; después, traza los flujos de trabajo solicitados para CLI en Linux, CLI en macOS y la UI de Xcode. Se considera terminado cuando las tres rutas de uso y sus limitaciones de los sanitizers estén documentadas para todas las plataformas.

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

Evaluación

Área
cli, devtools, documentation
Tipo de issue
Documentación
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.