From 9850276267ee8b1fcdd7a15b7099468980201fb1 Mon Sep 17 00:00:00 2001 From: Dean Michael Berris Date: Thu, 30 Nov 2017 05:35:51 +0000 Subject: [PATCH] [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. llvm-svn: 319400 --- llvm/docs/XRay.rst | 9 ++++++--- llvm/docs/XRayExample.rst | 2 +- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/llvm/docs/XRay.rst b/llvm/docs/XRay.rst index e9ecc13..b4443c4 100644 --- a/llvm/docs/XRay.rst +++ b/llvm/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 `_ friendly text + formats, as well as `Chrome Trace Viewer (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/llvm/docs/XRayExample.rst b/llvm/docs/XRayExample.rst index 56f1750..953833bc 100644 --- a/llvm/docs/XRayExample.rst +++ b/llvm/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. -- 2.7.4