From 9ae171bcd38cdefa64c9dd5d763d16007eebcd0d Mon Sep 17 00:00:00 2001 From: Johannes Doerfert Date: Wed, 23 Dec 2020 17:55:03 -0600 Subject: [PATCH] [OpenMP][Docs] Add remarks intro section Reviewed By: jhuber6 Differential Revision: https://reviews.llvm.org/D93735 --- openmp/docs/remarks/OptimizationRemarks.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/openmp/docs/remarks/OptimizationRemarks.rst b/openmp/docs/remarks/OptimizationRemarks.rst index 997a9a6..4c256fd 100644 --- a/openmp/docs/remarks/OptimizationRemarks.rst +++ b/openmp/docs/remarks/OptimizationRemarks.rst @@ -1,6 +1,31 @@ OpenMP Optimization Remarks =========================== +The :doc:`OpenMP-Aware optimization pass ` is able to +generate compiler remarks for performed and missed optimisations. To emit them, +pass ``-Rpass=openmp-opt``, ``-Rpass-analysis=openmp-opt``, and +``-Rpass-missed=openmp-opt`` to the Clang invocation. For more information and +features of the remark system the clang documentation should be consulted: + ++ `Clang options to emit optimization reports `_ ++ `Clang diagnostic and remark flags `_ ++ The `-foptimization-record-file flag + `_ + and the `-fsave-optimization-record flag + `_ + + +.. _ompXXX: + +Some OpenMP remarks start with a "tag", like `[OMP100]`, which indicates that +there is further information about them on this page. To directly jump to the +respective entry, navigate to +`https://openmp.llvm.org/docs/remarks/OptimizationRemarks.html#ompXXX `_ where `XXX` is +the three digit code shown in the tag. + + +---- + .. _omp100: .. _omp_no_external_caller_in_target_region: -- 2.7.4