Dual docs for llvm usage: cli and Xcode

Open
#8 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
cli, devtools, documentation

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.

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)
Dominant language
No language data
Stars
110
Forks
17
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from mapbox/cpp

All issues in mapbox/cpp

Similar issues

More CLI issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.