summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorDean Michael Berris <dberris@google.com>2017-03-30 23:46:36 +0000
committerDean Michael Berris <dberris@google.com>2017-03-30 23:46:36 +0000
commit21463ca861531c6e6ed69d084a8dc8c8b2ef1ddb (patch)
tree79fa9a66f1eda88b140382110e3eb09b2a009d3a /docs/index.rst
parent0b40dade4167f1fbb8bc296314e7d727ffb1430a (diff)
[XRay][docs] Examples for how to use XRay
Summary: This document is an attempt at showing how XRay could be used to debug latency issues with LLVM tools, and how to use the llvm-xray tool to analyse XRay traces. Reviewers: echristo, mehdi_amini, davide Subscribers: llvm-commits Differential Revision: https://reviews.llvm.org/D31493 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@299133 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 341a9c16325b..2385bb0f3cc8 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -399,6 +399,9 @@ For API clients and LLVM developers.
:doc:`XRay`
High-level documentation of how to use XRay in LLVM.
+:doc:`XRayExample`
+ An example of how to debug an application with XRay.
+
:doc:`The Microsoft PDB File Format <PDB/index>`
A detailed description of the Microsoft PDB (Program Database) file format.