Dual docs for llvm usage: cli and Xcode
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 110
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
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)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files or tests are named. Start by locating the existing LLVM documentation and its CLI and Xcode entry points, then map the requested Linux CLI, macOS CLI, and Xcode UI workflows. Done means all three usage paths and their sanitizer limitations are documented cross-platform.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, devtools, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100