From: Brian Gesiak <modocache@gmail.com>
Date: Wed, 5 Jul 2017 19:55:51 +0000 (+0000)
Subject: Add docs for -foptimization-record-file=
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=29e21c348d85b4a9b1525b876c669b4229e99930;p=clang

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
---

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**