Author: Johannes Doerfert Date: 2021-01-07T14:31:17-06:00 New Revision: 9ae171bcd38cdefa64c9dd5d763d16007eebcd0d
URL: https://github.com/llvm/llvm-project/commit/9ae171bcd38cdefa64c9dd5d763d16007eebcd0d DIFF: https://github.com/llvm/llvm-project/commit/9ae171bcd38cdefa64c9dd5d763d16007eebcd0d.diff LOG: [OpenMP][Docs] Add remarks intro section Reviewed By: jhuber6 Differential Revision: https://reviews.llvm.org/D93735 Added: Modified: openmp/docs/remarks/OptimizationRemarks.rst Removed: ################################################################################ diff --git a/openmp/docs/remarks/OptimizationRemarks.rst b/openmp/docs/remarks/OptimizationRemarks.rst index 997a9a6d98c2..4c256fd99694 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 </optimizations/OpenMPOpt>` 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 <https://clang.llvm.org/docs/UsersManual.html#options-to-emit-optimization-reports>`_ ++ `Clang diagnostic and remark flags <https://clang.llvm.org/docs/ClangCommandLineReference.html#diagnostic-flags>`_ ++ The `-foptimization-record-file flag + <https://clang.llvm.org/docs/ClangCommandLineReference.html#cmdoption-clang-foptimization-record-file>`_ + and the `-fsave-optimization-record flag + <https://clang.llvm.org/docs/ClangCommandLineReference.html#cmdoption-clang1-fsave-optimization-record>`_ + + +.. _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 <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: _______________________________________________ llvm-branch-commits mailing list llvm-branch-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-branch-commits