summaryrefslogtreecommitdiffstats
path: root/docs/UsersManual.rst
diff options
context:
space:
mode:
authorBrian Gesiak <modocache@gmail.com>2017-07-05 19:55:51 +0000
committerBrian Gesiak <modocache@gmail.com>2017-07-05 19:55:51 +0000
commit29e21c348d85b4a9b1525b876c669b4229e99930 (patch)
treef52d25e8dddcaaf7feee2fb67d16ee4fc6d239e9 /docs/UsersManual.rst
parente300395c3743046138e53faa7e7c4dee15ba0470 (diff)
Add docs for -foptimization-record-file=
Summary: The Clang option was previously not included in the User's Manual. Reviewers: anemet, davidxl, hfinkel Reviewed By: hfinkel Subscribers: cfe-commits Differential Revision: https://reviews.llvm.org/D34928 git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@307193 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/UsersManual.rst')
-rw-r--r--docs/UsersManual.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/UsersManual.rst b/docs/UsersManual.rst
index df6344af91..387ec63e9c 100644
--- a/docs/UsersManual.rst
+++ b/docs/UsersManual.rst
@@ -332,6 +332,19 @@ output format of the diagnostics that it generates.
using a structured YAML format, users can parse or sort the remarks in a
convenient way.
+.. _opt_foptimization-record-file:
+
+**-foptimization-record-file**
+ Control the file to which optimization reports are written.
+
+ When optimization reports are being output (see
+ :ref:`-fsave-optimization-record <opt_fsave-optimization-record>`), this
+ option controls the file to which those reports are written.
+
+ If this option is not used, optimization records are output to a file named
+ after the primary file being compiled. If that's "foo.c", for example,
+ optimization records are output to "foo.opt.yaml".
+
.. _opt_fdiagnostics-show-hotness:
**-f[no-]diagnostics-show-hotness**