diff options
| author | Dimitry Andric <dim@FreeBSD.org> | 2017-07-01 13:24:05 +0000 | 
|---|---|---|
| committer | Dimitry Andric <dim@FreeBSD.org> | 2017-07-01 13:24:05 +0000 | 
| commit | cf1b401909b5e54edfd80656b1a18eaa31f9f6f1 (patch) | |
| tree | edb0ffff2a43d84ba9b4c862b394cfeeebb36ddc /docs/UsersManual.rst | |
| parent | ef915aab0ac566c55bfb0d7a9f6635bb5d94d4af (diff) | |
Diffstat (limited to 'docs/UsersManual.rst')
| -rw-r--r-- | docs/UsersManual.rst | 40 | 
1 files changed, 33 insertions, 7 deletions
diff --git a/docs/UsersManual.rst b/docs/UsersManual.rst index 7362456202ba..df6344af9102 100644 --- a/docs/UsersManual.rst +++ b/docs/UsersManual.rst @@ -322,18 +322,27 @@ output format of the diagnostics that it generates.     by category, so it should be a high level category. We want dozens     of these, not hundreds or thousands of them. +.. _opt_fsave-optimization-record: + +**-fsave-optimization-record** +   Write optimization remarks to a YAML file. + +   This option, which defaults to off, controls whether Clang writes +   optimization reports to a YAML file. By recording diagnostics in a file, +   using a structured YAML format, users can parse or sort the remarks in a +   convenient way. +  .. _opt_fdiagnostics-show-hotness:  **-f[no-]diagnostics-show-hotness**     Enable profile hotness information in diagnostic line. -   This option, which defaults to off, controls whether Clang prints the -   profile hotness associated with a diagnostics in the presence of -   profile-guided optimization information.  This is currently supported with -   optimization remarks (see :ref:`Options to Emit Optimization Reports -   <rpass>`).  The hotness information allows users to focus on the hot -   optimization remarks that are likely to be more relevant for run-time -   performance. +   This option controls whether Clang prints the profile hotness associated +   with diagnostics in the presence of profile-guided optimization information. +   This is currently supported with optimization remarks (see +   :ref:`Options to Emit Optimization Reports <rpass>`). The hotness information +   allows users to focus on the hot optimization remarks that are likely to be +   more relevant for run-time performance.     For example, in this output, the block containing the callsite of `foo` was     executed 3000 times according to the profile data: @@ -344,6 +353,23 @@ output format of the diagnostics that it generates.             sum += foo(x, x - 2);                    ^ +   This option is implied when +   :ref:`-fsave-optimization-record <opt_fsave-optimization-record>` is used. +   Otherwise, it defaults to off. + +.. _opt_fdiagnostics-hotness-threshold: + +**-fdiagnostics-hotness-threshold** +   Prevent optimization remarks from being output if they do not have at least +   this hotness value. + +   This option, which defaults to zero, controls the minimum hotness an +   optimization remark would need in order to be output by Clang. This is +   currently supported with optimization remarks (see :ref:`Options to Emit +   Optimization Reports <rpass>`) when profile hotness information in +   diagnostics is enabled (see +   :ref:`-fdiagnostics-show-hotness <opt_fdiagnostics-show-hotness>`). +  .. _opt_fdiagnostics-fixit-info:  **-f[no-]diagnostics-fixit-info**  | 
