This is an archive of the discontinued LLVM Phabricator instance.

[XRay][Docs] Add documentation for XRay in LLVM
ClosedPublic

Authored by dberris on Nov 7 2016, 10:02 PM.

Details

Summary

This is the initial version of the documentation for how to use XRay as
it stands in LLVM, Clang, and compiler-rt. We leave some room for later
expansion mentioining what is work in progress and what could be
expected moving forward.

We also give a high level overview of future work that's both ongoing
and planned.

Event Timeline

dberris updated this revision to Diff 77143.Nov 7 2016, 10:02 PM
dberris retitled this revision from to [XRay][Docs] Add documentation for XRay in LLVM.
dberris updated this object.
dberris added reviewers: echristo, dblaikie, chandlerc.
dberris added a subscriber: llvm-commits.
dberris updated this revision to Diff 77149.Nov 7 2016, 11:31 PM
  • Add XRay documentation in index.rst
dblaikie accepted this revision.Nov 8 2016, 1:09 PM
dblaikie edited edge metadata.

Looks like a good first start

docs/XRay.rst
19

'found /in/' rather than 'found /from/'?

44

"/in/ a couple of ways"

46

Presumably Obj C++ too? Not sure we have a tidy way to write that little matrix.

55

maybe drop the language compatibility list here ("for your application" instead) since it's mentioned previously

57

I might consider omitting this sentence or making it briefer ("For example: ").

This revision is now accepted and ready to land.Nov 8 2016, 1:09 PM
dberris updated this revision to Diff 77283.Nov 8 2016, 4:31 PM
dberris marked 5 inline comments as done.
dberris edited edge metadata.
  • Address review comments
This revision was automatically updated to reflect the committed changes.