diff --git a/llvm/docs/XRay.rst b/llvm/docs/XRay.rst --- a/llvm/docs/XRay.rst +++ b/llvm/docs/XRay.rst @@ -26,7 +26,7 @@ - Compiler-inserted instrumentation points. - A runtime library for enabling/disabling tracing at runtime. -- A suite of tools for analysing the traces. +- A suite of tools for analyzing the traces. **NOTE:** As of July 25, 2018 , XRay is only available for the following architectures running Linux: x86_64, arm7 (no thumb), aarch64, powerpc64le, @@ -47,7 +47,7 @@ - Instrumenting your C/C++/Objective-C/Objective-C++ application. - Generating LLVM IR with the correct function attributes. -The rest of this section covers these main ways and later on how to customise +The rest of this section covers these main ways and later on how to customize what XRay does in an XRay-instrumented binary. Instrumenting your C/C++/Objective-C Application @@ -316,7 +316,7 @@ XRay supports several different instrumentation points including ``function-entry``, ``function-exit``, ``custom``, and ``typed`` points. These can be enabled individually -using the ``-fxray-instrumentaton-bundle=`` flag. For example if you only wanted to +using the ``-fxray-instrumentation-bundle=`` flag. For example if you only wanted to instrument function entry and custom points you could specify: :: diff --git a/llvm/docs/XRayExample.rst b/llvm/docs/XRayExample.rst --- a/llvm/docs/XRayExample.rst +++ b/llvm/docs/XRayExample.rst @@ -63,7 +63,7 @@ $ XRAY_OPTIONS="patch_premain=true xray_mode=xray-basic verbosity=1" ./bin/llc input.ll ==69819==XRay: Log file in 'xray-log.llc.m35qPB' -At this point we now have an XRay trace we can start analysing. +At this point we now have an XRay trace we can start analyzing. The ``llvm-xray`` Tool ---------------------- @@ -319,7 +319,7 @@ $ XRAY_OPTIONS="patch_premain=true xray_mode=xray-basic" ./sample We can then explore the graph rendering of the trace generated by this sample -application. We assume you have the graphviz toosl available in your system, +application. We assume you have the graphviz tools available in your system, including both ``unflatten`` and ``dot``. If you prefer rendering or exploring the graph using another tool, then that should be feasible as well. ``llvm-xray graph`` will create DOT format graphs which should be usable in most graph