From: Dean Michael Berris <dberris@google.com>
Date: Thu, 30 Nov 2017 05:35:51 +0000 (+0000)
Subject: [XRay][docs] Update documentation on new default for xray_naive_log=
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=fe376dcd53c63856c8d535053728bfb3f35ddcce;p=llvm

[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.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@319400 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/docs/XRay.rst b/docs/XRay.rst
index e9ecc13e3b2..b4443c4d806 100644
--- a/docs/XRay.rst
+++ b/docs/XRay.rst
@@ -143,7 +143,7 @@ variable, where we list down the options and their defaults below.
 |                   |                 |               | 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
diff --git a/docs/XRayExample.rst b/docs/XRayExample.rst
index 56f17507d82..953833bc1ef 100644
--- a/docs/XRayExample.rst
+++ b/docs/XRayExample.rst
@@ -60,7 +60,7 @@ to enable XRay at application start. To do this, XRay checks the
   $ ./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.