[PATCH] D32438: Document how to capture linux perf profiles.

[Kristof Beyls via Phabricator via llvm-commits]

kristof.beyls created this revision.

After having made a few improvements to lnt runtest test-suite to improve support for capturing linux perf profiles, now also document explicitly how to enable that.


https://reviews.llvm.org/D32438

Files:
  docs/tests.rst


Index: docs/tests.rst
===================================================================
--- docs/tests.rst
+++ docs/tests.rst
@@ -253,6 +253,33 @@
 and the ``--cmake-define`` flag allow you to change how LNT configures cmake
 for the test-suite run.
 
+
+Capturing Linux perf profile info
++++++++++++++++++++++++++++++++++
+
+When using the CMake driver in the test-suite, LNT can also capture profile
+information using linux perf. This can then be explored through the LNT webUI
+as demonstrated at
+http://blog.llvm.org/2016/06/using-lnt-to-track-performance.html .
+
+To capture these profiles, use command line option ``--use-perf=all``. A
+typical command line using this for evaluating the performance of generated
+code looks something like the following::
+
+  $ lnt runtest test-suite \
+       --sandbox SANDBOX \
+       --cc ~/bin/clang \
+       --use-cmake=/usr/local/bin/cmake \
+       --use-lit=~/llvm/utils/lit/lit.py \
+       --test-suite ~/llvm-test-suite \
+       --benchmarking-only \
+       --build-threads 8 \
+       --threads 1 \
+       --use-perf=all \
+       --exec-multisample=5 \
+       --run-under 'taskset -c 1'
+
+
 Bisecting: ``--single-result`` and ``--single-result-predicate``
 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D32438.96407.patch
Type: text/x-patch
Size: 1292 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20170424/0bbd9bc4/attachment.bin>