mapbox / mapbox/cpp

Dual docs for llvm usage: cli and Xcode

Offen
#8 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Keine Sprachdaten
Sterne
110
Forks
17
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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)

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Es sind keine Dateien oder Tests benannt. Beginnen Sie damit, die vorhandene LLVM-Dokumentation sowie deren CLI- und Xcode-Einstiegspunkte zu finden, und bilden Sie anschließend die angeforderten Workflows für CLI unter Linux, CLI unter macOS und die Xcode-UI ab. Als erledigt gilt die Aufgabe, wenn alle drei Nutzungspfade und ihre Einschränkungen durch Sanitizer plattformübergreifend dokumentiert sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
cli, devtools, documentation
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.