diff options
author | Eric Christopher <echristo@gmail.com> | 2018-05-27 09:19:03 +0000 |
---|---|---|
committer | Eric Christopher <echristo@gmail.com> | 2018-05-27 09:19:03 +0000 |
commit | 66c5bbc53e0b215143ed65e20561e3c5bab80e93 (patch) | |
tree | 0384d3fa27ea5a38d2eb4f2abe9d18b2158160e4 /llvm/docs/XRayExample.rst | |
parent | 59949471c93f1b17957c6655a26e3e07550d77df (diff) | |
download | bcm5719-llvm-66c5bbc53e0b215143ed65e20561e3c5bab80e93.tar.gz bcm5719-llvm-66c5bbc53e0b215143ed65e20561e3c5bab80e93.zip |
Tidy some language in the xray documentation.
llvm-svn: 333354
Diffstat (limited to 'llvm/docs/XRayExample.rst')
-rw-r--r-- | llvm/docs/XRayExample.rst | 20 |
1 files changed, 9 insertions, 11 deletions
diff --git a/llvm/docs/XRayExample.rst b/llvm/docs/XRayExample.rst index eefb8cc8a43..e1b8c9b69d5 100644 --- a/llvm/docs/XRayExample.rst +++ b/llvm/docs/XRayExample.rst @@ -48,11 +48,11 @@ Getting Traces -------------- By default, XRay does not write out the trace files or patch the application -before main starts. If we just run ``llc`` it should just work like a normally -built binary. However, if we want to get a full trace of the application's -operations (of the functions we do end up instrumenting with XRay) then we need -to enable XRay at application start. To do this, XRay checks the -``XRAY_OPTIONS`` environment variable. +before main starts. If we run ``llc`` it should work like a normally built +binary. If we want to get a full trace of the application's operations (of the +functions we do end up instrumenting with XRay) then we need to enable XRay +at application start. To do this, XRay checks the ``XRAY_OPTIONS`` environment +variable. :: @@ -73,9 +73,8 @@ instrumented, and how much time we're spending in parts of the code. To make sense of this data, we use the ``llvm-xray`` tool which has a few subcommands to help us understand our trace. -One of the simplest things we can do is to get an accounting of the functions -that have been instrumented. We can see an example accounting with ``llvm-xray -account``: +One of the things we can do is to get an accounting of the functions that have +been instrumented. We can see an example accounting with ``llvm-xray account``: :: @@ -202,8 +201,7 @@ Given a trace, and optionally an instrumentation map, the ``llvm-xray stack`` command can be used to analyze a call stack graph constructed from the function call timeline. -The simplest way to use the command is simply to output the top stacks by call -count and time spent. +The way to use the command is to output the top stacks by call count and time spent. :: @@ -245,7 +243,7 @@ FlameGraph tool, currently available on `github To generate output for a flamegraph, a few more options are necessary. -- ``-all-stacks`` - Emits all of the stacks instead of just the top stacks. +- ``-all-stacks`` - Emits all of the stacks. - ``-stack-format`` - Choose the flamegraph output format 'flame'. - ``-aggregation-type`` - Choose the metric to graph. |