mapbox / mapbox/cpp

Dual docs for llvm usage: cli and Xcode

Aperta
#8 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Nessun dato sulla lingua
Stelle
110
Fork
17
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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)

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Non sono indicati file né test. Inizia individuando la documentazione LLVM esistente e i relativi punti di accesso CLI e Xcode, quindi mappa i workflow richiesti per la CLI Linux, la CLI macOS e la UI Xcode. Il lavoro è completo quando tutti e tre i percorsi di utilizzo e le relative limitazioni dei sanitizer sono documentati su tutte le piattaforme.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
cli, devtools, documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.