Dual docs for llvm usage: cli and Xcode
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Không có dữ liệu ngôn ngữ
- Star
- 110
- Fork
- 17
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
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)
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Không có tệp hoặc bài kiểm thử nào được nêu tên. Hãy bắt đầu bằng cách xác định tài liệu LLVM hiện có cùng các điểm truy cập CLI và Xcode của tài liệu đó, sau đó lập bản đồ các workflow được yêu cầu cho CLI trên Linux, CLI trên macOS và UI Xcode. Công việc được xem là hoàn tất khi cả ba đường dẫn sử dụng và các giới hạn sanitizer của chúng được ghi lại trên mọi nền tảng.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Lĩnh vực
- cli, devtools, documentation
- Loại issue
- Tài liệu
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100