Dual docs for llvm usage: cli and Xcode
まだ誰も着手していません。
- 主要言語
- 言語のデータがありません
- スター
- 110
- フォーク
- 17
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
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)
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
ファイルやテストは指定されていません。まず既存の LLVM ドキュメントとその CLI および Xcode のエントリーポイントを見つけ、次に要求されている Linux CLI、macOS CLI、Xcode UI のワークフローを整理してください。3 つすべての使用経路とそれぞれの sanitizer の制限事項がクロスプラットフォームで文書化されていれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 領域
- cli, devtools, documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100