[Openmp-commits] [PATCH] D93735: [OpenMP][Docs] Add remarks intro section

[Johannes Doerfert via Phabricator via Openmp-commits]

jdoerfert created this revision.
jdoerfert added reviewers: tianshilei1992, jhuber6.
Herald added subscribers: guansong, bollu, yaxunl.
jdoerfert requested review of this revision.
Herald added a subscriber: sstefan1.
Herald added a project: OpenMP.

Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D93735

Files:
  openmp/docs/remarks/OptimizationRemarks.rst


Index: openmp/docs/remarks/OptimizationRemarks.rst
===================================================================
--- openmp/docs/remarks/OptimizationRemarks.rst
+++ 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`` and ``-Rpass-missed=openmp`` 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:


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D93735.313450.patch
Type: text/x-patch
Size: 1668 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/openmp-commits/attachments/20201223/6ef648b3/attachment.bin>