diff options
| author | Roman Lebedev <lebedev.ri@gmail.com> | 2019-02-04 09:12:08 +0000 |
|---|---|---|
| committer | Roman Lebedev <lebedev.ri@gmail.com> | 2019-02-04 09:12:08 +0000 |
| commit | 21193f4b7e535bfde54fd4b93fd5a0f3169a99ef (patch) | |
| tree | 943184c12a27ee2eb16f16d685cd73d4cf3ef628 /llvm/docs/CommandGuide | |
| parent | 31df1adbe9f3490cf8d6dcbbcddb706711b75066 (diff) | |
| download | bcm5719-llvm-21193f4b7e535bfde54fd4b93fd5a0f3169a99ef.tar.gz bcm5719-llvm-21193f4b7e535bfde54fd4b93fd5a0f3169a99ef.zip | |
[llvm-exegesis] Don't default to running&dumping all analyses to '-'
Summary:
Up until the point i have looked in the source, i didn't even understood that
i can disable 'cluster' output. I have always silenced it via ` &> /dev/null`.
(And hoped it wasn't contributing much of the run time.)
While i expect that it has it's use-cases i never once needed it so far.
If i forget to silence it, console is completely flooded with that output.
How about not expecting users to opt-out of analyses,
but to explicitly specify the analyses that should be performed?
Reviewers: courbet, gchatelet
Reviewed By: courbet
Subscribers: tschuett, RKSimon, llvm-commits
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D57648
llvm-svn: 353021
Diffstat (limited to 'llvm/docs/CommandGuide')
| -rw-r--r-- | llvm/docs/CommandGuide/llvm-exegesis.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/llvm/docs/CommandGuide/llvm-exegesis.rst b/llvm/docs/CommandGuide/llvm-exegesis.rst index bbd90563005..878ced3c3bf 100644 --- a/llvm/docs/CommandGuide/llvm-exegesis.rst +++ b/llvm/docs/CommandGuide/llvm-exegesis.rst @@ -190,7 +190,9 @@ OPTIONS .. option:: -mode=[latency|uops|inverse_throughput|analysis] - Specify the run mode. + Specify the run mode. Note that if you pick `analysis` mode, you also need + to specify at least one of the `-analysis-clusters-output-file=` and + `-analysis-inconsistencies-output-file=`. .. option:: -num-repetitions=<Number of repetition> @@ -205,12 +207,12 @@ OPTIONS .. option:: -analysis-clusters-output-file=</path/to/file> If provided, write the analysis clusters as CSV to this file. "-" prints to - stdout. + stdout. By default, this analysis is not run. .. option:: -analysis-inconsistencies-output-file=</path/to/file> If non-empty, write inconsistencies found during analysis to this file. `-` - prints to stdout. + prints to stdout. By default, this analysis is not run. .. option:: -analysis-numpoints=<dbscan numPoints parameter> |
