Dual docs for llvm usage: cli and Xcode
Personne n'a encore pris cette issue.
- Langage dominant
- Aucune donnée de langage
- Étoiles
- 110
- Forks
- 17
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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)
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Aucun fichier ni test n’est nommé. Commencez par localiser la documentation LLVM existante ainsi que ses points d’entrée CLI et Xcode, puis cartographiez les workflows demandés pour la CLI Linux, la CLI macOS et l’UI Xcode. Le travail est terminé lorsque les trois parcours d’utilisation et leurs limitations liées aux sanitizers sont documentés sur toutes les plateformes.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Domaine
- cli, devtools, documentation
- Type d'issue
- Documentation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100