[PATCH] D26386: [XRay][Docs] Add documentation for XRay in LLVM

[David Blaikie via llvm-commits]

dblaikie accepted this revision.
dblaikie added a comment.
This revision is now accepted and ready to land.

Looks like a good first start



================
Comment at: docs/XRay.rst:18
+
+More high level information about XRay can be found from the `XRay whitepaper`_.
+
----------------
'found /in/' rather than 'found /from/'?


================
Comment at: docs/XRay.rst:43
+
+You can use XRay through a couple of ways:
+
----------------
"/in/ a couple of ways"


================
Comment at: docs/XRay.rst:45
+
+- Instrumenting your C/C++/Objective-C application.
+- Generating LLVM IR with the correct function attributes.
----------------
Presumably Obj C++ too? Not sure we have a tidy way to write that little matrix.


================
Comment at: docs/XRay.rst:54
+
+The easiest way of getting XRay instrumentation for your C/C++/Objective-C
+binary is by enabling the ``-fxray-instrument`` flag in your clang invocation.
----------------
maybe drop the language compatibility list here ("for your application" instead) since it's mentioned previously


================
Comment at: docs/XRay.rst:56
+binary is by enabling the ``-fxray-instrument`` flag in your clang invocation.
+An example of that would look like:
+
----------------
I might consider omitting this sentence or making it briefer ("For example: ").


https://reviews.llvm.org/D26386