[llvm] r319400 - [XRay][docs] Update documentation on new default for xray_naive_log=
Dean Michael Berris via llvm-commits
llvm-commits at lists.llvm.org
Wed Nov 29 21:35:51 PST 2017
Author: dberris
Date: Wed Nov 29 21:35:51 2017
New Revision: 319400
URL: http://llvm.org/viewvc/llvm-project?rev=319400&view=rev
Log:
[XRay][docs] Update documentation on new default for xray_naive_log=
We've recently changed the default for `xray_naive_log=` to be `false`
instead of `true` to make it more consistent with the FDR mode logging
implementation. This means we will now ask users to explicitly choose
which version of the XRay logging is being used.
Modified:
llvm/trunk/docs/XRay.rst
llvm/trunk/docs/XRayExample.rst
Modified: llvm/trunk/docs/XRay.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/XRay.rst?rev=319400&r1=319399&r2=319400&view=diff
==============================================================================
--- llvm/trunk/docs/XRay.rst (original)
+++ llvm/trunk/docs/XRay.rst Wed Nov 29 21:35:51 2017
@@ -143,7 +143,7 @@ variable, where we list down the options
| | | | instrumentation points |
| | | | before main. |
+-------------------+-----------------+---------------+------------------------+
-| xray_naive_log | ``bool`` | ``true`` | Whether to install |
+| xray_naive_log | ``bool`` | ``false`` | Whether to install |
| | | | the naive log |
| | | | implementation. |
+-------------------+-----------------+---------------+------------------------+
@@ -258,8 +258,11 @@ supports the following subcommands:
- ``account``: Performs basic function call accounting statistics with various
options for sorting, and output formats (supports CSV, YAML, and
console-friendly TEXT).
-- ``convert``: Converts an XRay log file from one format to another. Currently
- only converts to YAML.
+- ``convert``: Converts an XRay log file from one format to another. We can
+ convert from binary XRay traces (both naive and FDR mode) to YAML,
+ `flame-graph <https://github.com/brendangregg/FlameGraph>`_ friendly text
+ formats, as well as `Chrome Trace Viewer (catapult)
+ <https://github.com/catapult-project/catapult>` formats.
- ``graph``: Generates a DOT graph of the function call relationships between
functions found in an XRay trace.
- ``stack``: Reconstructs function call stacks from a timeline of function
Modified: llvm/trunk/docs/XRayExample.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/XRayExample.rst?rev=319400&r1=319399&r2=319400&view=diff
==============================================================================
--- llvm/trunk/docs/XRayExample.rst (original)
+++ llvm/trunk/docs/XRayExample.rst Wed Nov 29 21:35:51 2017
@@ -60,7 +60,7 @@ to enable XRay at application start. To
$ ./bin/llc input.ll
# We need to set the XRAY_OPTIONS to enable some features.
- $ XRAY_OPTIONS="patch_premain=true" ./bin/llc input.ll
+ $ XRAY_OPTIONS="patch_premain=true xray_naive_log=true" ./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.
More information about the llvm-commits
mailing list